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

document DeclareCategoryCollections; document constructors; improve reference manual; add NameOfCategoryCollections helper #3469

Merged
merged 6 commits into from
May 28, 2019

Conversation

fingolfin
Copy link
Member

The commit adding an explanation for constructors is stolen from @stevelinton's PR #611, albeit in slightly modified form. If this PR here is merged, I'll update PR #611 accordingly.

@fingolfin fingolfin added kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements topic: documentation Issues and PRs related to documentation topic: library release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes labels May 21, 2019
@codecov
Copy link

codecov bot commented May 22, 2019

Codecov Report

Merging #3469 into master will decrease coverage by 4.95%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #3469      +/-   ##
==========================================
- Coverage   85.34%   80.38%   -4.96%     
==========================================
  Files         699      696       -3     
  Lines      346479   343212    -3267     
==========================================
- Hits       295708   275900   -19808     
- Misses      50771    67312   +16541
Impacted Files Coverage Δ
lib/domain.gd 100% <ø> (ø) ⬆️
src/c_oper1.c 86.53% <ø> (ø) ⬆️
src/hpc/c_oper1.c 86.17% <ø> (ø) ⬆️
lib/type.g 85.3% <ø> (ø) ⬆️
lib/coll.gd 95.16% <100%> (+0.06%) ⬆️
lib/ctbllatt.gi 4.94% <0%> (-79.62%) ⬇️
lib/proto.gi 13.4% <0%> (-71.14%) ⬇️
lib/schursym.gi 10.6% <0%> (-58.51%) ⬇️
lib/ctblpope.gi 19.61% <0%> (-57.87%) ⬇️
lib/addgphom.gi 8.69% <0%> (-56.53%) ⬇️
... and 173 more

@coveralls
Copy link

coveralls commented May 22, 2019

Coverage Status

Coverage decreased (-0.0001%) to 85.167% when pulling 1d0031c on fingolfin:mh/doc into 4437e09 on gap-system:master.

Copy link
Contributor

@markusbaumeister markusbaumeister left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From reading the code, this looks good (better organised). There are some small improvements that could be made.

doc/ref/domain.xml Outdated Show resolved Hide resolved
doc/ref/domain.xml Show resolved Hide resolved
doc/ref/methsel.xml Outdated Show resolved Hide resolved
doc/ref/methsel.xml Outdated Show resolved Hide resolved
doc/ref/types.xml Show resolved Hide resolved
fingolfin and others added 6 commits May 23, 2019 14:33
Many packages use DeclareCategoryCollections, so it seems sensible
to document it officially.
Split DeclareCategoryCollections and move parts of it into a new helper
function NameOfCategoryCollections. This is useful for AutoDoc.
Right now, a lot of information on filters, categories, representations
etc. is scattered over multiple chapters and sections in the manual,
making it hard to get a good overview about them. This commit is a first
step towards improving this situation.
Specifically, move the documentation for NewCategory, NewAttributes,
NewOperation etc. to the chapters and sections which deal with categories,
attributes, operations, ...
@fingolfin fingolfin changed the title document DeclareCategoryCollections; add NameOfCategoryCollections helper; improve reference manual document DeclareCategoryCollections; document constructors; improve reference manual; add NameOfCategoryCollections helper May 24, 2019
@fingolfin fingolfin merged commit 5fbcf2b into gap-system:master May 28, 2019
@fingolfin fingolfin deleted the mh/doc branch May 28, 2019 12:38
@DominikBernhardt DominikBernhardt added release notes: added PRs introducing changes that have since been mentioned in the release notes and removed release notes: to be added PRs introducing changes that should be (but have not yet been) mentioned in the release notes labels Aug 21, 2019
@olexandr-konovalov olexandr-konovalov added this to the GAP 4.11.0 milestone Feb 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements release notes: added PRs introducing changes that have since been mentioned in the release notes topic: documentation Issues and PRs related to documentation topic: library
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants