Skip to content
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

Merged
merged 1 commit into from
Sep 19, 2018

Conversation

wilfwilson
Copy link
Member

@wilfwilson wilfwilson commented Sep 19, 2018

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 that InfoWarning 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.

@wilfwilson wilfwilson added kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements topic: documentation Issues and PRs related to documentation release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes gapdays2018-fall Issues and PRs that arose at https://www.gapdays.de/gapdays2018-fall labels Sep 19, 2018
Copy link
Member

@olexandr-konovalov olexandr-konovalov left a 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.

@codecov
Copy link

codecov bot commented Sep 19, 2018

Codecov Report

Merging #2834 into master will decrease coverage by 22.17%.
The diff coverage is n/a.

@@             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
Impacted Files Coverage Δ
lib/teachm2.g 0% <0%> (-100%) ⬇️
lib/attr.gi 0% <0%> (-100%) ⬇️
lib/contfrac.gi 0% <0%> (-89.48%) ⬇️
lib/helpt2t.gi 0% <0%> (-83.34%) ⬇️
lib/proto.gi 0% <0%> (-83.34%) ⬇️
lib/ctblauto.gi 0% <0%> (-83.18%) ⬇️
lib/ctbllatt.gi 0% <0%> (-80.72%) ⬇️
lib/teaching.g 3.43% <0%> (-76.17%) ⬇️
lib/algliess.gi 0% <0%> (-75.23%) ⬇️
lib/ctblpope.gi 0% <0%> (-73.86%) ⬇️
... and 370 more

@wilfwilson
Copy link
Member Author

@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.

Copy link
Member

@fingolfin fingolfin left a 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?

@olexandr-konovalov
Copy link
Member

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).

@olexandr-konovalov olexandr-konovalov merged commit 869a9d3 into gap-system:master Sep 19, 2018
@wilfwilson wilfwilson deleted the fix-info-doc branch September 19, 2018 21:33
@wilfwilson wilfwilson added release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes and removed release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes labels Sep 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-to-4.10-DONE gapdays2018-fall Issues and PRs that arose at https://www.gapdays.de/gapdays2018-fall kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements release notes: not needed PRs introducing changes that are wholly irrelevant to the release notes topic: documentation Issues and PRs related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants