document DeclareCategoryCollections; document constructors; improve reference manual; add NameOfCategoryCollections helper #3469
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fingolfin
added
kind: enhancement
fingolfin
requested review from
ChrisJefferson,
sebasguts,
olexandr-konovalov,
stevelinton,
ssiccha,
markusbaumeister and
PaulaHaehndel
Codecov Report
@@ 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
|
markusbaumeister
approved these changes
May 22, 2019
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
changed the title
DominikBernhardt
added
release notes: added
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.