Docs: Add json docs. #3754
Merged
Docs: Add json docs. #3754
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
I think the json_add document focuses on how JSON-related code is used. Not exactly introduce output_files. How about move tnem into docs/advanced/json/.? |
OK, second it. |
pxlxingliang
approved these changes
Mar 25, 2024
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.
Added some documents related to json in abacus.
Linked Issue
Fix #3753
What's changed?
Two json documents have been added in the docs/advanced directory.
json_para: Describes the structure of the abacus.json file output by abacus and the meanings of each parameter.
json_add: Describes the current implementation path of json code in abacus and how to use the current json addition function in abacus to build a json tree.
A example abacus.json file:
examples/relax/pw_al