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

Fix README heading ordering, add missing heading_id opts #65

Merged
merged 2 commits into from
Apr 18, 2023

Conversation

MattIPv4
Copy link
Member

@MattIPv4 MattIPv4 commented Apr 18, 2023

Type of Change

  • Something else: Docs

What issue does this relate to?

N/A

What should this PR do?

Fixes the ordering/levels of the headings in the README so that the limit_tokens plugin information is a sub-heading of the plugins, rather than being an isolated top-level heading further down the document.

Fixes the listed options for the heading_id plugin, as I forgot in #64 that the nested options for hash links are also included in the README.

What are the acceptance criteria?

limit_tokens heading is correctly nested under the plugins list in the README.

heading_id hash link options are correctly listed in the README.

@MattIPv4 MattIPv4 added the documentation Improvements or additions to documentation label Apr 18, 2023
@MattIPv4 MattIPv4 changed the title Fix README heading ordering Fix README heading ordering, add missing heading_id opts Apr 18, 2023
@MattIPv4 MattIPv4 merged commit 4847d9a into master Apr 18, 2023
@MattIPv4 MattIPv4 deleted the MattIPv4/readme-headings branch April 18, 2023 20:07
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

Successfully merging this pull request may close these issues.

None yet

2 participants