Adding Descriptions to Nodes for Documentation Purposes #6
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
My team and I are using a deep analysis of our Structr definitions to automatically generate documentation for our API.
I've been wanting to add a "description" property to the Structr nodes for a while, so that we can provide some semantic documentation as well, in a similar way.
This is also handy because we can use it to provide more meaningful error messages if a value in the client's payload isn't right for some reason.