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

Convert inline code references to use double backticks in the standard library #9

Open
tothambrus11 opened this issue Jun 26, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@tothambrus11
Copy link
Collaborator

tothambrus11 commented Jun 26, 2024

We have already converted the standard library to use our new syntax for special sections inside https://github.com/hylo-lang/hylodoc/tree/dev/Sources/StandardLibrary/Sources

Hylo code references are still not updated though, so there are still places where `myFunction(_:)` is written instead of ``myFunction(_:)``.

Updating the standard library to use this syntax would make the references be checked when generating the documentation, so it would be harder to accidentally making documentation obsolete when doing some refactoring.

For the details of the syntax, see https://github.com/hylo-lang/hylodoc/blob/dev/SyntaxReference.md#symbol-references

@tothambrus11 tothambrus11 added the documentation Improvements or additions to documentation label Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant