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.

Sign up for GitHub

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

Jump to bottom

Correct type annotation for inspect to match README #22

Merged
merged 2 commits into from
Dec 5, 2024
Merged

Correct type annotation for inspect to match README #22

merged 2 commits into from
Dec 5, 2024

Conversation

erickzhao
Copy link
Contributor

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and discussions and couldn’t find anything or linked relevant results below
  • I made sure the docs are up to date
  • I included tests (or that’s not needed)

Description of changes

The description of the inspect function in the type annotation does not match the description in the README and is misleading.

@erickzhao
Update index.js
e04afac 
Signed-off-by: Erick Zhao <[email protected]>
@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Nov 28, 2024
@erickzhao erickzhao changed the title Update index.js Correct type annotation for inspect to match README Nov 28, 2024
wooorm
wooorm reviewed Nov 30, 2024
View reviewed changes
Copy link
Member

@wooorm wooorm left a comment

Choose a reason for hiding this comment

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

Good catch!

lib/index.js Outdated Show resolved Hide resolved
@wooorm wooorm merged commit c4c334e into syntax-tree:main Dec 5, 2024
2 checks passed
@wooorm
Copy link
Member

wooorm commented Dec 5, 2024

Thank you! :)

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@wooorm wooorm added 📚 area/docs This affects documentation ☂️ area/types This affects typings 💪 phase/solved Post is done labels Dec 5, 2024
@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Dec 5, 2024
@erickzhao erickzhao deleted the patch-1 branch December 5, 2024 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wooorm wooorm wooorm approved these changes

Assignees
No one assigned
Labels
📚 area/docs This affects documentation ☂️ area/types This affects typings 💪 phase/solved Post is done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@erickzhao @wooorm