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

Rename Markdown util getHeaders() to getHeadings() #4031

Merged
merged 3 commits into from
Jul 23, 2022
Merged

Conversation

natemoo-re
Copy link
Member

@natemoo-re natemoo-re commented Jul 23, 2022

Changes

This PR renames the getHeaders() function to getHeadings(). According to the HTML spec, these are headings. "headers" are not part of the HTML spec. MDN also uses "headings" to refer to tags h1 through h6.

Testing

CI passes

Docs

This change deprecates one function in favor of the other without breaking things.

Docs PR: withastro/docs#1107

@changeset-bot
Copy link

changeset-bot bot commented Jul 23, 2022

🦋 Changeset detected

Latest commit: f1a6539

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 13 packages
Name Type
astro Patch
@astrojs/markdown-remark Minor
@e2e/astro-component Patch
@e2e/error-react-spectrum Patch
@e2e/error-sass Patch
@e2e/errors Patch
@e2e/lit-component Patch
@e2e/preact-component Patch
@e2e/react-component Patch
@e2e/solid-component Patch
@e2e/svelte-component Patch
@e2e/e2e-tailwindcss Patch
@e2e/ts-resolution Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) pkg: example Related to an example package (scope) feat: markdown Related to Markdown (scope) labels Jul 23, 2022
@natemoo-re natemoo-re changed the title Renamed getHeaders() to getHeadings(), according to RFC #208. Rename Markdown util getHeaders() to getHeadings() Jul 23, 2022
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks Nate 🙌

@natemoo-re natemoo-re merged commit 6e27a5f into main Jul 23, 2022
@natemoo-re natemoo-re deleted the felixsanz/main branch July 23, 2022 22:23
@astrobot-houston astrobot-houston mentioned this pull request Jul 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat: markdown Related to Markdown (scope) pkg: astro Related to the core `astro` package (scope) pkg: example Related to an example package (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants