Fixing up minor errors within the documentation #1784
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
Bus-Based tutorials The error was located within the paragraph that described the sets of flip-flops used to register the input and output ports. Originally, the documentation listed that there were 64 flip-flops for the output port, but it should be 72 flip-flops.
section The first error was found under the "row" tag description. Originally, one of the optional attributes was "icry", this was changed to "incrx". Since horizontal increments are in the x-axis. The second error was found under the "region" tag description. Originally, the description for the optional attribute "incry" was "An expression specifying the horizontal increment between block instantiations within the region.", horizontal was changed to vertical. The third error was found under the "equivalent_sites" tag description. Originally the note under the "direct" tag said "This tag is need only if the pin_mapping of the site is defined as custom", need was changed to needed.
|
Looks good; thanks Srivatsan. |
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.
Fixed documentation errors found within the architecture modelling tutorials section and the architectural reference section.
Description
within the region." instead of "An expression specifying the horizontal increment between block instantiations
within the region."
Related Issue
Motivation and Context
This change fixed errors within the VTR documentation. These changes were necessary as they help create a more clearer documentation for other users
How Has This Been Tested?
The documentation was built after the changes and visual confirmation was done to make sure the changes were applied and that there were no build issues with the documentation.
Additionally, the basic and strong tests were done to ensure proper functionality.
Types of changes
Checklist: