fuzion icon indicating copy to clipboard operation
fuzion copied to clipboard

Documentation improvement discussion

Open simonvonhackewitz opened this issue 10 months ago • 3 comments

  1. 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? Image

  2. Include public arguments in the constructor section, because they can be called similar to inner features

Any other improvements or ideas @tokiwa-software/developers ?

simonvonhackewitz avatar Feb 05 '25 13:02 simonvonhackewitz

what are public arguments and where is the constructor section, or is that just a different wording of the first point?

maxteufel avatar Feb 06 '25 12:02 maxteufel

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.

simonvonhackewitz avatar Feb 07 '25 09:02 simonvonhackewitz

Show pre- and postconditions in the api docs

simonvonhackewitz avatar Aug 05 '25 09:08 simonvonhackewitz