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

docs: update option documentation #1141

Merged
merged 4 commits into from
Jun 28, 2024
Merged

docs: update option documentation #1141

merged 4 commits into from
Jun 28, 2024

Conversation

erickzhao
Copy link
Member

@erickzhao erickzhao commented Jun 11, 2024

Adds inline documentation for options and updates the CLI options according to the latest --help flag output.

Part of the push to add TypeDoc everywhere but stops just short since there are Node.js compatibility issues with the latest versions of TypeDoc.

@erickzhao erickzhao requested a review from a team as a code owner June 11, 2024 23:58
@codecov-commenter
Copy link

codecov-commenter commented Jun 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@b8ac6db). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1141   +/-   ##
=======================================
  Coverage        ?   76.93%           
=======================================
  Files           ?       21           
  Lines           ?      763           
  Branches        ?      142           
=======================================
  Hits            ?      587           
  Misses          ?      122           
  Partials        ?       54           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

README.md Outdated Show resolved Hide resolved
@erickzhao erickzhao requested a review from erikian June 27, 2024 15:45
@erickzhao erickzhao merged commit d1fbc59 into main Jun 28, 2024
2 checks passed
@erickzhao erickzhao deleted the docs/update-option-docs branch June 28, 2024 19:53
Copy link

🎉 This PR is included in version 3.6.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants