You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We need a standard way of documenting struct fields in the code, as the documentation is derived from this. We can use this issue to collect several problems and desiderata.
As an example, how do we want to make transparent to the user, whether or not an attribute (struct field) is obligatory. In most cases we mention the default value in the docstring, but to conclude from a non-mentioning of a default that a field is required seems a bit much.
The text was updated successfully, but these errors were encountered:
Also, it would be nice to add a way of print a code snippet from the documentation in a way that it can be copied from command line, which is currently not possible with the terminal tables.
... in a way, that it also reads the field attributes and creates constants for optional and obligatory fields (i. e. which field carries serde(default... and which not), we could forward that information to the user.
We need a standard way of documenting struct fields in the code, as the documentation is derived from this. We can use this issue to collect several problems and desiderata.
As an example, how do we want to make transparent to the user, whether or not an attribute (struct field) is obligatory. In most cases we mention the default value in the docstring, but to conclude from a non-mentioning of a default that a field is required seems a bit much.
The text was updated successfully, but these errors were encountered: