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

New Editorial Practice: If a characteristic of an example pattern implementation is optional, document optionality with link to pattern #1320

Open
mcking65 opened this issue Feb 3, 2020 · 0 comments
Assignees
Labels
editorial Changes to prose that don't alter intended meaning, e.g., phrasing, grammar. May fix inaccuracies. Example Page Related to a page containing an example implementation of a pattern

Comments

@mcking65
Copy link
Contributor

mcking65 commented Feb 3, 2020

Questions and confusion can arise when the example implementation of a design pattern implements an optional behavior or characteristic and the documentation of that behavior or characteristic on the example page does not inform readers that it is optional. For example, see #1318.

Develop an editorial convention for highlighting optional or recommended aspects of examples. consider providing a link to the design pattern at the point where the behavior or characteristic is documented on the example page.

Propose a convention in a PR to address #1318.

@mcking65 mcking65 added editorial Changes to prose that don't alter intended meaning, e.g., phrasing, grammar. May fix inaccuracies. Example Page Related to a page containing an example implementation of a pattern labels Feb 3, 2020
@mcking65 mcking65 self-assigned this Feb 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Changes to prose that don't alter intended meaning, e.g., phrasing, grammar. May fix inaccuracies. Example Page Related to a page containing an example implementation of a pattern
Projects
None yet
Development

No branches or pull requests

1 participant