starkware-libs / cairo

Cairo is the first Turing-complete language for creating provable programs for general computation.
Apache License 2.0
1.6k stars 495 forks source link

Typo Update readme.md #6693

Closed mdqst closed 3 hours ago

mdqst commented 5 hours ago

Description:

This pull request fixes a minor but potentially confusing typo in the "View in PDF" section of the documentation.

Issue:

In the final command under "Convert to PDF," there was an unnecessary backtick (`) at the end of the command:

asciidoctor-pdf src/*.adoc`  

Fix:

The command has been corrected by removing the stray backtick:

asciidoctor-pdf src/*.adoc  

Importance of Fix:

  1. Clarity: Ensures readers can copy-paste the command directly without encountering syntax errors.
  2. User Experience: Reduces confusion for users, especially those new to using asciidoctor-pdf.
  3. Consistency: Maintains professional and error-free documentation.

Testing:

Please review and merge this fix to improve the documentation's accuracy.

reviewable-StarkWare commented 5 hours ago

This change is Reviewable