lunduniversity / introprog

Teaching material for "Introduction to Programming using Scala" at Lund University, LTH. http://cs.lth.se/pgk/
142 stars 176 forks source link

Misleading tip in 4.2 Objects question 7a #754

Closed lego-eden closed 3 months ago

lego-eden commented 1 year ago

In 4.2 Objects question 7a, the tip says to look into the introprog docs (docs) in the PixelWindow class to find out what the default arguments are when you create one. However there are no default arguments shown in the documentation.

My suggestion for this if to change the tip to hint at looking in the code (pixelwindow class) for info about the default arguments, or alternatively updating the docs to show the default arguments.

I will probably not submit a pull request myself.

bjornregnell commented 1 year ago

Thanks for reporting. I or someone else will make a PR eventually. Perhaps we should check if the later version of scaladoc generates documentation that shows default arguments in doc so that there is no need to investigate the default values in the code.

bjornregnell commented 1 year ago

Is the new scaladoc in its lates version capable of rendering default arguments? Investigations needed. And a new api doc for introprog-scalalib should be generated.