Add property type descriptions to JSON model #913
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tillprochaska
force-pushed
the
till/type-descriptions-json-model
branch
from
10becc8 to
99e17f5
Compare
This is necessary as the tests rely on the type descriptions being present in the JSON model.
tillprochaska
force-pushed
the
till/type-descriptions-json-model
branch
from
99e17f5 to
39eaa35
Compare
tillprochaska
commented
Nov 25, 2022
| @@ -183,6 +184,7 @@ def to_dict(self) -> PropertyTypeToDict: | |||
| data: PropertyTypeToDict = { | |||
| "label": gettext(self.label), | |||
| "plural": gettext(self.plural), | |||
| "description": gettext(self.docs), | |||
There was a problem hiding this comment.
We currently don’t translate the descriptions and I’m not sure if we ever will, but it doesn’t hurt either…
pudo
approved these changes
Nov 28, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We already include schema descriptions in the JSON model, this improves consistency across types and schemata.
I’ve also converted the property type doc strings from reStructuredText to Markdown. I think the main reason for using reST is the current documentation setup is using Sphinx, but we’re mostly moving away from that and Markdown is a more common format.