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.

Sign up for GitHub

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

Jump to bottom

Document immutability of ranges in the JavaDocs #1813

Closed
gissuebot opened this issue Oct 31, 2014 · 2 comments · Fixed by #3915
Closed

Document immutability of ranges in the JavaDocs #1813

gissuebot opened this issue Oct 31, 2014 · 2 comments · Fixed by #3915
Assignees
@kluever
Labels
P2 package=collect status=triaged type=api-docs Change/add API documentation

Comments

@gissuebot
Copy link

gissuebot commented Oct 31, 2014 •
edited by cgdecker
Loading

Original issue created by j...@nwsnet.de on 2014-07-23 at 03:21 PM

I didn't find information on the immutability of Range instances in the JavaDocs [1]; only the wiki page [2] explicitly states it.

I suggest documenting the immutability directly in the JavaDocs, and thus in the implementation itself.

[1] https://google.github.io/guava/apidocs/com/google/common/collect/Range.html
[2] https://code.google.com/p/guava-libraries/wiki/RangesExplained

(Slightly unrelated: The comments disappeared from the wiki, especially helpful ones which I remembered to be on the page on ranges are gone. I'd like to state that I don't welcome that change.)
@gissuebot
Copy link
Author

Original comment posted by kevinb@google.com on 2014-07-23 at 03:44 PM

Augh! How terrible.

Status: Accepted
Labels: Type-ApiDocs, Package-Collect

@cgdecker cgdecker removed the migrated label Nov 1, 2014
@raghsriniv raghsriniv added the P3 label Jun 24, 2019
@kluever kluever added P2 and removed P3 labels Sep 13, 2019
@kluever
Copy link
Member

kluever commented Sep 13, 2019

Seems straight-forward and easy.

@netdpb netdpb mentioned this issue Jun 1, 2020
Merged
netdpb pushed a commit that referenced this issue Jun 1, 2020
@kluever @netdpb
Document that Ranges are immutable.
9485ee0 
Fixes #1813

RELNOTES=n/a

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=313873952
@kluever kluever closed this as completed Jun 1, 2020
netdpb pushed a commit that referenced this issue Jun 1, 2020
@kluever @netdpb
Document that Ranges are immutable.
abea458 
Fixes #1813

RELNOTES=n/a

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=313873952
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kluever kluever

Labels
P2 package=collect status=triaged type=api-docs Change/add API documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

MOE Sync 2020-06-01 google/guava
4 participants
@cgdecker @kluever @gissuebot @raghsriniv