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

(placeholder) @schema/doc Schema annotation #466

Closed
cari-lynn opened this issue Jul 27, 2021 · 1 comment
Closed

(placeholder) @schema/doc Schema annotation #466

cari-lynn opened this issue Jul 27, 2021 · 1 comment
Labels
enhancement This issue is a feature request priority/important-soon Must be staffed and worked on currently or soon.

Comments

@cari-lynn
Copy link
Contributor

@schema/doc

Sets the text describing the purpose of the node.

@schema/doc documentation
  • documentation (string) — a more thorough description of the node or section that shares the context
    of the node, enumerates the range of possible values, explaining the effects of certain value ranges.
    • often these strings include formatting typography (e.g. HTML or Markdown) to support display of these
      values in documentation settings.

Example 1: Short description

#@schema/doc "The user password used to log in to the system"
user_password: ""
@aaronshurley aaronshurley added enhancement This issue is a feature request priority/important-soon Must be staffed and worked on currently or soon. labels Aug 23, 2021
@cari-lynn
Copy link
Contributor Author

After some discussion, we determined that this issue is not needed, since there is not work that needs to be done to allow this annotation. The work will be done in #469.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue is a feature request priority/important-soon Must be staffed and worked on currently or soon.
Projects
None yet
Development

No branches or pull requests

2 participants