Documentation improvement discussion
-
Add additional section for all arguments (including private ones) which will contain the current sections "Type parameters" and "Fields" Any ideas or suggestions for the design?
-
Include public arguments in the constructor section, because they can be called similar to inner features
Any other improvements or ideas @tokiwa-software/developers ?
what are public arguments and where is the constructor section, or is that just a different wording of the first point?
Public arguments are declared with public and currently only they show up in the apidocs because only they can be accessed by a user.
E.g. array has four more non public arguments. If you have
arr := array 5 i->i*i
you can do
say arr.T
but not
say arr.internal_array
The constructor section contains inner features defined with is, e.g. in eff.
Show pre- and postconditions in the api docs