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

Examples description is incorrect #7

Open
xpqz opened this issue Jan 13, 2025 · 0 comments
Open

Examples description is incorrect #7

xpqz opened this issue Jan 13, 2025 · 0 comments
Assignees

Comments

@xpqz
Copy link
Collaborator

xpqz commented Jan 13, 2025

The examples section is incorrect and the instructions doesn't work in the real documentation. The .example class is for backwards compatibility. Examples are either semantically significant (use a normal heading and a better name than "Example"), or not (just introduce it as part of the text). If you absolutely want to use a heading called "Example", use the .example class on the heading. This excludes it from the ToC.

@xpqz xpqz self-assigned this Jan 13, 2025
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

No branches or pull requests

1 participant