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: JSONValue docs are not published #10721

Closed
1 task done
Riezebos opened this issue Jan 25, 2025 · 2 comments · Fixed by #10722
Closed
1 task done

docs: JSONValue docs are not published #10721

Riezebos opened this issue Jan 25, 2025 · 2 comments · Fixed by #10722
Labels
docs Documentation related issues or PRs
Milestone

Comments

@Riezebos
Copy link
Contributor

Please describe the issue

I was trying to figure out how to work with columns of type json, after some time I stumbled on great docstrings in this file that helped me a lot: https://github.com/ibis-project/ibis/blob/main/ibis/expr/types/json.py

I can't seem to find them in the published docs though. Searching for "json" gives a bunch of results that are not this. Searching for "JSONValue" gives no results at all. I've also browsed through the reference but I really can't find these docs at all. Am I looking in the wrong place?

Code of Conduct

  • I agree to follow this project's Code of Conduct
@Riezebos Riezebos added the docs Documentation related issues or PRs label Jan 25, 2025
@cpcloud
Copy link
Member

cpcloud commented Jan 25, 2025

Interesting, thanks for the kinds words the bug report!

I think you're probably looking in the correct location, but we may not be publishing these (which is unintentional).

Will take a look today!

@github-project-automation github-project-automation bot moved this from backlog to done in Ibis planning and roadmap Jan 25, 2025
@github-actions github-actions bot added this to the 10.0 milestone Jan 25, 2025
@Riezebos
Copy link
Contributor Author

@cpcloud the docstring of JSONValue.__getitem__ is quite helpful but that one still not visible in the docs. It could technically be shown by setting include_private: true in the quartodoc options but that would probably do a lot of other unwanted stuff. Maybe line 35-99 can be moved to be the JSONValue class docstring? While those lines are technically examples of how to use __getitem__, in my opinion they also qualify as good examples of how to use JSONValue in general.

Happy to create an MR if you think this is a good idea

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related issues or PRs
Projects
Status: done
Development

Successfully merging a pull request may close this issue.

2 participants