document basic representations of objects (IsInternalRep, IsDataObjectRep, IsComponentObjectRep, IsPositionalObjectRep, IsAttributeStoringRep, IsPlistRep)
#3615
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
ThomasBreuer
added
topic: documentation
fingolfin
approved these changes
Aug 21, 2019
lib/list.gd
Outdated
| ## | ||
| ## <Description> | ||
| ## &GAP; lists created by entering comma separated values in square brackets | ||
| ## are represented internally as so-called <E>plain lists</E>, |
There was a problem hiding this comment.
Note that this is not 100% correct: for boolean lists, GAP returns a blist rep:
gap> IsPlistRep( [ true, false ] );
false
gap> IsBlistRep( [ true, false ] );
true
There was a problem hiding this comment.
Good point. I will fix this.
lib/type.g
Outdated
| ## <!-- This will be changed eventually, in order to avoid conflicts between--> | ||
| ## <!-- ordinary components and components corresponding to attributes.--> | ||
| ## This will be changed eventually, in order to avoid conflicts between | ||
| ## ordinary components and components corresponding to attributes.--> |
There was a problem hiding this comment.
Perhaps we should just remove those last 4-5 lines?
There was a problem hiding this comment.
Yes.
Note that the rule for the component names had not been commented out before, but still it was not part of the documentation since the GAPDoc "chunk" was not requested by any of the XML files.
- document `IsInternalRep`, `IsDataObjectRep`, `IsComponentObjectRep`, `IsPositionalObjectRep`, `IsAttributeStoringRep`, `IsPlistRep` Up to now, these representations were either not documented at all or just via `<Index>` entries in some general text. - adjusted the relevant cross-references: Use `<Ref...>` instead of `<C>` elements.
ThomasBreuer
force-pushed
the
TB_document_representations
branch
from
cbf11a0
to
93668e2
Compare
Codecov Report
@@ Coverage Diff @@
## master #3615 +/- ##
===========================================
- Coverage 84.64% 72.27% -12.38%
===========================================
Files 698 635 -63
Lines 345549 308791 -36758
===========================================
- Hits 292483 223171 -69312
- Misses 53066 85620 +32554
|
|
@fingolfin I have updated my pull request according to your comments. |
DominikBernhardt
approved these changes
Aug 22, 2019
fingolfin
changed the title
IsInternalRep, IsDataObjectRep, IsComponentObjectRep, IsPositionalObjectRep, IsAttributeStoringRep, IsPlistRep)
fingolfin
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.
documented
IsInternalRep,IsDataObjectRep,IsComponentObjectRep,IsPositionalObjectRep,IsAttributeStoringRep,IsPlistRepUp to now, these representations were either not documented at all
or just via
<Index>entries in some general text.I would like to refer to some of these representations in the documentation for
IsMatrixObjandIsVectorObj; for that, they should be properly documented.adjusted the relevant cross-references:
Use
<Ref...>instead of<C>elements.