Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation #571

Merged

Conversation

bjoern-jueliger-sap
Copy link
Member

Part two of #557: The language in the documentation was often inconsistent and sometimes did not reflect the actual behavior of the checks.

Particular attention to:

  • Consistent capitalization (e.g. no "Check" unless using title case)
  • Consistent language, in particular for technical terms such as "static" vs "dynamic".
  • Explicit mention of equivalent SAP-delivered checks (like in Issue in using pseudo comment "#EC EQUALS_CHAINING #569) when they exist

bjoern-jueliger-sap and others added 8 commits May 24, 2022 11:12
Particular focus:
 - consistent language
 - consistent capitalization (lots of unnecessary capitalization
    removed)
 - proper use of technical terms (e.g. "static" vs. "dynamic")
@bjoern-jueliger-sap bjoern-jueliger-sap merged commit 2c3ce28 into SAP:master Sep 23, 2022
@bjoern-jueliger-sap bjoern-jueliger-sap deleted the better-documentation branch September 23, 2022 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant