Skip to content

docs: clarify the IGNORE_ANCHORS parser attribute - #455

Open
Hugohong258 wants to merge 1 commit into
Alir3z4:masterfrom
Hugohong258:docs-ignore-links-option-mapping
Open

Hugohong258 wants to merge 1 commit into
Alir3z4:masterfrom
Hugohong258:docs-ignore-links-option-mapping

Conversation

@Hugohong258

Copy link
Copy Markdown

The usage guide lists IGNORE_ANCHORS and tells readers to set configuration options on the parser, but its corresponding attribute is ignore_links. Setting ignore_anchors = True leaves link formatting enabled. Document the exception and its relationship to --ignore-links.

Related to #415. Checked the default, the ineffective attribute, and the documented ignore_links setting against the current source; rendered the updated Markdown; and ran the existing suite (196 passed). This changes documentation only, with the changelog and author entry required by the contribution guide.

This branch has not been deployed

No deployments
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