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

Standardize fields and their docstrings #256

Open
MartinKl opened this issue Jun 25, 2024 · 0 comments
Open

Standardize fields and their docstrings #256

MartinKl opened this issue Jun 25, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@MartinKl
Copy link
Collaborator

Fields of structs that perform imports, graph_ops, or exports should always have a default value. When a default is not possible, such as for path attributes, it should be wrapped in an Option to opt for None as default. This might shift semantics, but is for the greater good.

Docstrings should always provide an example of how to use it in a toml file to provide a hint to the type.

@MartinKl MartinKl self-assigned this Jun 25, 2024
@MartinKl MartinKl added the enhancement New feature or request label Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant