docs: make info.version more visible #1639
Merged
Conversation
This file contains hidden or 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
In the `info` section, then `description` is about 500 lines long. This makes it a little tricky to see other properties of the `info` section. This PR moves the `description` to the end of the `info` section. Noted while reviewing getodk#1633 and trying to understand what the `license` property belonged to.
sadiqkhoja
approved these changes
Oct 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
In the
infosection, thendescriptionis about 500 lines long. This makes it tricky to see other properties of theinfosection.This PR moves the
descriptionto the end of theinfosection.Noted while reviewing #1633 and trying to understand what the
licenseproperty belonged to.What has been done to verify that this works as intended?
CI.
Why is this the best possible solution? Were any other approaches considered?
Status quo is annoying.
How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?
No change.
Does this change require updates to the API documentation? If so, please update docs/api.yaml as part of this PR.
No.
Before submitting this PR, please make sure you have:
make testand confirmed all checks still pass OR confirm CircleCI build passes