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

document default values for options #687

Closed
milyin opened this issue Jan 26, 2024 · 1 comment · Fixed by #774
Closed

document default values for options #687

milyin opened this issue Jan 26, 2024 · 1 comment · Fixed by #774
Assignees
Labels
documentation Improvements or additions to documentation release Part of the next release

Comments

@milyin
Copy link
Contributor

milyin commented Jan 26, 2024

Describe the release item

When creating entity it's not clear which settings it will have by default, if the setting is simple type. For complex types, implementing default() method it's more clear. E.g. for allowed_origin method we can look into definition of Locality type and ensure, that default is Locality::Any
But for example for QueryableBuilder it's unknown is completeness option true or false by default without deep dive into sources.

This should be explicit. The rule is: if option accepts value of base type or if type is not base, but default value of this option is not the default value for the type, this default option value should be documented.

Maybe define constants for these values in the API, but this to be decided.

@milyin milyin added documentation Improvements or additions to documentation release Part of the next release labels Jan 26, 2024
@milyin milyin self-assigned this Jan 26, 2024
@milyin milyin moved this to Backlog in Zenoh 1.0.0 release Jan 26, 2024
@milyin
Copy link
Contributor Author

milyin commented Mar 12, 2024

Mostly duplication of #732, fixed in #729

@milyin milyin moved this from Backlog to In review in Zenoh 1.0.0 release Mar 12, 2024
@milyin milyin linked a pull request Mar 12, 2024 that will close this issue
@Mallets Mallets closed this as completed Jun 25, 2024
@github-project-automation github-project-automation bot moved this from In review to Done in Zenoh 1.0.0 release Jun 25, 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 release Part of the next release
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants