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

Consistent example captions #98

Closed
zimeon opened this issue Sep 14, 2023 · 2 comments · Fixed by #121
Closed

Consistent example captions #98

zimeon opened this issue Sep 14, 2023 · 2 comments · Fixed by #121
Assignees

Comments

@zimeon
Copy link
Member

zimeon commented Sep 14, 2023

At the moment the document is not consistent with the formatting or labeling of examples. Common labels have the form:

  • #### FULL EXAMPLE for Change Set:
  • #### FULL EXAMPLE for Entity Patch
  • #### EXAMPLE Entity Change Activity for Create sometimes followed with "Complete example"
  • EXAMPLE Entity Change Activity for Update (not a heading)
@zimeon
Copy link
Member Author

zimeon commented Sep 14, 2023

I'm not convinced that all-caps EXAMPLE is very helpful or pretty, I think we should consistently use level 4 headings, and I think it is useful to indicate whether an example is a complete JSON document or a snippet.

I propose the following two forms:

  • #### Complete example of X Y Z
  • #### Example excerpt of X Y Z

@zimeon
Copy link
Member Author

zimeon commented Sep 28, 2023

I think this was fixed in #109 but will leave for later checks/corrections

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants