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

Update Markdown Syntax for URL in Header #1232

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

0xwitty
Copy link

@0xwitty 0xwitty commented Nov 26, 2024

Problem

The URL in the header for the class hash documentation is incorrectly formatted. The current syntax:

:class-hash-cairo-version: \
https://crates.io/crates/cairo-lang-compiler/{cmp_version}[cairo {cmp_version}]

is not valid Markdown for embedding a link.

Solution

The link syntax has been updated to properly follow Markdown standards:

:class-hash-cairo-version: https://crates.io/crates/cairo-lang-compiler/{cmp_version} [cairo {cmp_version}]

Importance

  • Clarity: Correctly formatted links ensure that users can click and access the intended documentation without confusion.
  • Professionalism: Proper formatting enhances the readability and usability of generated documentation.
  • Functionality: A malformed link can break automated tools that parse or render the documentation.

This small change significantly improves the quality of the generated documentation and aligns it with standard practices.

PR Checklist

  • Tests
  • Documentation
  • Added entry to CHANGELOG.md
  • Tried the feature on a public network

The URL in the header for the class hash documentation is incorrectly formatted.
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.

1 participant