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

Add documentation to polars datasets explaining how to use OmegaConf resolvers #886

Open
datajoely opened this issue Oct 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation Hacktoberfest

Comments

@datajoely
Copy link
Contributor

datajoely commented Oct 11, 2024

Description

Is your feature request related to a problem? A clear and concise description of what the problem is: "I'm always frustrated when ..."

See user issue here: #884 (comment)

We actually document custom polars resolvers in the resolvers documentation, but it's very easy for a user to never see this. The user suggested to put this in the dataset(s) docstring which I think is a great idea.

Possible Alternatives

(Optional) Describe any alternative solutions or features you've considered.

Link to resolvers in the YAML rather than recreating it

@datajoely datajoely changed the title a Add documentation to polars datasets explaining how to use OmegaConf resolvers Oct 11, 2024
@datajoely datajoely added the documentation Improvements or additions to documentation label Oct 11, 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 Hacktoberfest
Projects
Status: To Do
Status: Todo
Development

No branches or pull requests

2 participants