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

get_record_options docs: mention that it won't recurse into nested options #36

Open
kyleam opened this issue Feb 5, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@kyleam
Copy link
Collaborator

kyleam commented Feb 5, 2024

#35 (comment)

Do you think it could be worth adding some context about it being for 'simple cases' to the helper doc at some point (obviously low priority though)?

Sure, doc improvements are always welcome. In this case, it'd need more thought than my quick reply. I don't think I'd say "simple cases" in the docs because I'm not sure it's really that. As far as I know, it has full support for returning all of a record's option (with the documented caveat for the name "option"); it's just not going to recurse into every nested option and return their options. So, I think it should probably be framed in that way.

@kyleam kyleam added the documentation Improvements or additions to documentation label Feb 5, 2024
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
Projects
None yet
Development

No branches or pull requests

1 participant