Closed mdqst closed 10 hours ago
Thank you for your contribution to the Noir language.
Please do not force push to this branch after the Noir team have started review of this PR. Doing so will only delay us merging your PR as we will need to start the review process from scratch.
Thanks for your understanding.
Description
This pull request addresses several documentation errors across different files. Each error has been identified and corrected to improve the clarity and accuracy of the documentation.
1. Fix double slash in the link to unconstrained functions
docs/docs/explainers/explainer-oracle.md
//
in the link tounconstrained.md
in the Use cases section.Importance: Correcting this ensures the link functions properly and leads to the intended document without causing any navigation issues.
Before:
[unconstrained functions](../noir/concepts//unconstrained.md)
After:
[unconstrained functions](../noir/concepts/unconstrained.md)
2. Grammar correction for verb tense
docs/docs/explainers/explainer-writing-noir.md
Importance: The correction improves the sentence's grammatical accuracy, ensuring the documentation is clear and professional.
Before:
And these constraints differ depending on where the compiled code is execute.
After:
And these constraints differ depending on where the compiled code is executed.
3. Capitalization of step number
docs/docs/getting_started/noir_installation.md
Importance: This small but important fix improves the visual consistency of the document and ensures clarity for users following the instructions.
Before:
step 2: Follow the Noirup instructions.
After:
Step 2: Follow the Noirup instructions.
4. Remove extra backtick in Zsh completion section
docs/docs/getting_started/setting_up_shell_completions.md
Importance: This correction ensures that the command is correctly formatted and can be used without errors, improving the user experience.
Before:
`bash mkdir -p ~/.oh-my-zsh/completions``
After:
bash mkdir -p ~/.oh-my-zsh/completions
5. Grammar correction for plural form of "unconstrained function"
docs/docs/how_to/how-to-oracles.md
Importance: This change ensures that the terminology is grammatically correct and accurately reflects the subject of the sentence.
Before:
An unconstrained method - This tells the compiler that it is executing an [unconstrained functions](../noir/concepts//unconstrained.md).
After:
An unconstrained method - This tells the compiler that it is executing an [unconstrained function](../noir/concepts/unconstrained.md).
These corrections are important to ensure that the documentation is clear, precise, and free of errors, contributing to a better experience for developers and users interacting with the materials.
Documentation*
Check one:
PR Checklist*
cargo fmt
on default settings.