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: Add simpleTraverse function docs #10615

Open
2 tasks done
aleclarson opened this issue Jan 5, 2025 · 2 comments
Open
2 tasks done

Docs: Add simpleTraverse function docs #10615

aleclarson opened this issue Jan 5, 2025 · 2 comments
Labels
documentation Documentation ("docs") that needs adding/updating triage Waiting for team members to take a look

Comments

@aleclarson
Copy link

aleclarson commented Jan 5, 2025

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

Add a page in the docs for simpleTraverse

Affected URL(s)

N/A

Additional Info

Screenshot of the documentation site's searchbox showing no results for simpleTraverse
@aleclarson aleclarson added documentation Documentation ("docs") that needs adding/updating triage Waiting for team members to take a look labels Jan 5, 2025
Copy link

github-actions bot commented Jan 5, 2025

Uh oh! @aleclarson, the image you shared is missing helpful alt text. Check your issue body.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.

🤖 Beep boop! This comment was added automatically by github/accessibility-alt-text-bot.

@bradzacher
Copy link
Member

bradzacher commented Jan 5, 2025

simpleTraverse is really an internal API we export for use across packages inside of our repo. This is why it lacks JSDoc documentation and lacks an entry in our official docs.

We sadly can't mark it as @internal and have it be used in our other packages.

What is your usecase?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation ("docs") that needs adding/updating triage Waiting for team members to take a look
Projects
None yet
Development

No branches or pull requests

2 participants