-
Notifications
You must be signed in to change notification settings - Fork 160
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
Improve manual section about Info classes #2834
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks!
Please remember to check makemanuals
in Travis for errors that may be shown in the log without failing the build.
If you want to improve it further, maybe also add that usually info classes are mentioned in the documentation of appropriate functionality; not all of them are documented at the moment, so ??Info
may not discover all of them (also something to be improved), but one can try to enter Info
and press Tab twice to see their names. Maybe also add an index entry for "verbosity of GAP output", which may be helpful to newcomers looking for such functionality.
c3701c0
to
5b38698
Compare
Codecov Report
@@ Coverage Diff @@
## master #2834 +/- ##
===========================================
- Coverage 76.05% 53.88% -22.18%
===========================================
Files 480 328 -152
Lines 241022 165097 -75925
===========================================
- Hits 183310 88961 -94349
- Misses 57712 76136 +18424
|
@alex-konovalov I implemented some of your changes: I added an index entry, and I mentioned the lack of documentation and the existence of package info classes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice, thank you!
I actually think this could be mentioned in the release notes, but I guess it's one of those case were you could argue either way?
Looks good, thanks @wilfwilson. I think it's worth to backport to GAP 4.10 (as those info classes that are explicitly mentioned there are all present in GAP 4.10). |
I've tweaked the documentation about
Info
classes. Mostly these are language adjustments, to make it clearer in my opinion, and to specify that an info level can be any non-negative integer. More seriously, the documentation previously said thatInfoWarning
is the only class to start with a non-zero info level; but there are several more, and so I have updated the documentation to match the behaviour of GAP.Note that this addresses some of my confusion mentioned in the discussion on #2809.