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

Missing documentation for structure of JSON/dict input to Dataset() #910

Open
poldrack opened this issue Dec 16, 2024 · 1 comment · May be fixed by #911
Open

Missing documentation for structure of JSON/dict input to Dataset() #910

poldrack opened this issue Dec 16, 2024 · 1 comment · May be fixed by #911
Assignees
Labels
bug Issues noting problems and PRs fixing those problems.

Comments

@poldrack
Copy link

Summary

I can't find any explicit documentation of the JSON/dict input format on the readthedocs site. I was able to reverse-engineer it from one of the examples, but it would be nice to have a page that outlines all of the possible keys and values that one might use when generating one's own custom input.

What were you trying to do?

Generate my own dictionary input for Dataset()

What did you expect to happen?

I expected to find documentation on the web site regarding the expected structure of the dictionary.

What actually happened?

I had to reverse engineer the format from an example when I didn't find any documentation.

@poldrack poldrack added the bug Issues noting problems and PRs fixing those problems. label Dec 16, 2024
@JulioAPeraza
Copy link
Collaborator

Thank you for bringing this to our attention. You're absolutely right. We'll work on adding this documentation to the website as soon as possible.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issues noting problems and PRs fixing those problems.
Projects
None yet
2 participants