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

In download_X() functions, make types more accessible #22

Closed
patrick-weiss opened this issue Jun 21, 2024 · 2 comments · Fixed by #26
Closed

In download_X() functions, make types more accessible #22

patrick-weiss opened this issue Jun 21, 2024 · 2 comments · Fixed by #26
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@patrick-weiss
Copy link
Member

After using the download functions in a new project, I found the types not clear enough for the user. Should we highlight the types in the documentation?

Additionally, the function list_supported_types() should be mentioned if option 'type' is not supported. We might also consider an option in list_supported_types() to only show domain-specific types, and an option to automatically print all available types (instead of the tibble default length).

What do you think?

@patrick-weiss patrick-weiss added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 21, 2024
@christophscheuch
Copy link
Member

I support all of your suggestions 👍🏻

@christophscheuch christophscheuch self-assigned this Jul 3, 2024
@christophscheuch
Copy link
Member

I updated the error message in case a type is not supported and I added the parameters domain and as_vector to the list_supported_types() function. I don't want to explicitly mention the types in the roxygen comments because this gets horrible to maintain.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants