Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typo Update readme.md #6693

Merged
merged 1 commit into from
Nov 19, 2024
Merged

Typo Update readme.md #6693

merged 1 commit into from
Nov 19, 2024

Conversation

mdqst
Copy link
Contributor

@mdqst mdqst commented Nov 19, 2024

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:

  • Verified that the corrected command executes without errors.
  • Ensured consistency with other commands in the documentation.

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

Fix typo in "View in PDF" section of documentation
@reviewable-StarkWare
Copy link

This change is Reviewable

Copy link
Collaborator

@orizi orizi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @mdqst)

@orizi orizi enabled auto-merge November 19, 2024 10:15
@orizi orizi added this pull request to the merge queue Nov 19, 2024
Merged via the queue into starkware-libs:main with commit 40db73a Nov 19, 2024
47 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants