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

Regenerate docs #2132

Merged
merged 1 commit into from
Sep 23, 2024
Merged

Regenerate docs #2132

merged 1 commit into from
Sep 23, 2024

Conversation

CvX
Copy link
Contributor

@CvX CvX commented Sep 18, 2024

  1. It looks like the docs (API.md) hasn't been regenerated in a while, specifically after 14.0 documentation bump, and there have been a couple of regressions. Those are fixed by additional annotations (@hideconstructor, @ignore, etc.) and argument renames.
  2. There was one change earlier this year that modified API.md directly. I applied it to documentation.yml instead. (this changed the index numeration hence the large commit diff)
  3. After the migration to pnpm some scripts weren't updated and still tried (and failed) to use npm. I updated package.json and CONTRIBUTING.md

1. It looks like the docs (API.md) hasn't been regenerated in a while, specifically after 14.0 `documentation` bump, and there have been a couple of regressions. Those are fixed by additional annotations (`@hideconstructor`, `@ignore`, etc. or argument renames)
2. There was one change earlier this year that modified API.md directly. I applied it to documentation.yml instead. (this changed the index numeration hence the large commit diff)
3. After the migration to pnpm some scripts weren't updated and still tried (and failed) to use npm. I updated package.json and CONTRIBUTING.md
@BobrImperator BobrImperator merged commit a91c68d into mainmatter:master Sep 23, 2024
7 checks passed
@github-actions github-actions bot mentioned this pull request Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants