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 IsRangeRep and improve the documentation of ConvertToRangeRep, IsRange, and the section Ranges #3472

Merged
merged 1 commit into from
Jun 27, 2019

Conversation

ssiccha
Copy link
Contributor

@ssiccha ssiccha commented May 24, 2019

Documents IsRangeRep.

Restructures ConvertToRangeRep:

  • remove some redundant statements
  • move some explanations to the IsRangeRep doc

Adds examples to IsRange and the info that assigning to a range turns it
into a plain list.

Improves the example in the introduction of the Ranges section,

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

coveralls commented May 24, 2019

Coverage Status

Coverage remained the same at 85.259% when pulling cae9e01 on ssiccha:ss/doc-IsRangeRep into 597c793 on gap-system:master.

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.

The commit message claims: "Restructures ConvertToRangeRep:" but I think this should be "Restructures the ConvertToRangeRep documentation:"

doc/ref/lists.xml Outdated Show resolved Hide resolved
lib/list.g Outdated Show resolved Hide resolved
lib/list.g Outdated Show resolved Hide resolved
lib/list.g Outdated Show resolved Hide resolved
lib/list.g Outdated Show resolved Hide resolved
lib/list.g Outdated Show resolved Hide resolved
lib/list.g Outdated Show resolved Hide resolved
lib/list.g Outdated Show resolved Hide resolved
@ssiccha
Copy link
Contributor Author

ssiccha commented May 25, 2019

The commit message claims: "Restructures ConvertToRangeRep:" but I think this should be "Restructures the ConvertToRangeRep documentation:"

Done

@codecov
Copy link

codecov bot commented May 25, 2019

Codecov Report

Merging #3472 into master will increase coverage by 4.87%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3472      +/-   ##
==========================================
+ Coverage   80.47%   85.34%   +4.87%     
==========================================
  Files         696      699       +3     
  Lines      343497   346902    +3405     
==========================================
+ Hits       276413   296077   +19664     
+ Misses      67084    50825   -16259
Impacted Files Coverage Δ
lib/list.g 100% <ø> (ø) ⬆️
lib/gprdpc.gi 45.74% <0%> (-42.2%) ⬇️
src/julia_gc.c 77.4% <0%> (-5.33%) ⬇️
lib/gpprmsya.gi 78.29% <0%> (-2.69%) ⬇️
src/listfunc.c 94.4% <0%> (-1.32%) ⬇️
lib/domain.gd 98.87% <0%> (-1.13%) ⬇️
lib/csetgrp.gi 74.19% <0%> (-0.68%) ⬇️
lib/ghompcgs.gi 91.35% <0%> (-0.67%) ⬇️
src/records.c 87.43% <0%> (-0.66%) ⬇️
src/system.c 73.78% <0%> (-0.58%) ⬇️
... and 189 more

Copy link
Member

@wilfwilson wilfwilson left a comment

Choose a reason for hiding this comment

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

I think this in good shape. I agree with @fingolfin that the 'will' should be changed to 'may'. I suggested a different way of changing the language of this line, in my opinion it improves things.

lib/list.g Outdated Show resolved Hide resolved
lib/list.g Outdated Show resolved Hide resolved
@ssiccha ssiccha force-pushed the ss/doc-IsRangeRep branch 2 times, most recently from 66f9c84 to 3c3275c Compare June 24, 2019 09:59
@ssiccha
Copy link
Contributor Author

ssiccha commented Jun 24, 2019

I just pushed the newest version.

... `ConvertToRangeRep`, `IsRange`, and the section `Ranges`

Documents `IsRangeRep`.

Restructures the `ConvertToRangeRep` documentation:
- remove some redundant statements
- move some explanations to the `IsRangeRep` doc
  - The documentation previously specified that an object in `IsRangeRep`
    *is* converted into a plain list if a value is assigned to one of its
    entries. This is changed to say that in this case the representation
    *may* be changed.

Adds examples to `IsRange` and the info that assigning to a range turns
it into a plain list.

Improves the example in the introduction of the `Ranges` section,
@ssiccha
Copy link
Contributor Author

ssiccha commented Jun 24, 2019

Rebased onto master.

@fingolfin fingolfin merged commit 384ccc4 into gap-system:master Jun 27, 2019
@ssiccha ssiccha deleted the ss/doc-IsRangeRep branch August 7, 2019 08:47
@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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants