documentation for Range property "page" is incomplete
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start with the linked Range documentation page, especially the page property section and the related max_value description. Verify the described clamping and scrollbar range behavior, then update the documentation so the effective maximum and grabber-length explanation are accurate and complete.
Written by the indexing model from the issue text.
Description
Your Godot version:
Godot 4
Issue description:
The documentation for Range's "page" property states simply:
Page size. Used mainly for ScrollBar. A ScrollBar's grabber length is the ScrollBar's size multiplied by page over the difference between min_value and max_value.
From my own testing I think this is misleading and incomplete. It seems page size actually alters the effective maximum value of the Range. i.e. a Range with a max_value of 100 and a page of 10 will actually be clamped to 90. That's not mentioned anywhere, not under page nor under max_value. This also makes the statement about the ScrollBar's grabber length technically inaccurate since it's actually the ratio between page and the effective range that matters (i.e. max - min - page and not simply max - min).
URL to the documentation page (if already existing):
https://docs.godotengine.org/en/stable/classes/class_range.html#class-range-property-page
- Dominant language
- reStructuredText
- Stars
- 5.7k
- Forks
- 3.8k
- Avg merge
- 7d 14h
- Merged PRs (30d)
- 41
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from godotengine/godot-docs
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
godotengine/godot-docs#12394 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
godotengine/godot-docs#12366 · 1 comment ·
-
area:class reference area:manual enhancement topic:2d topic:physics
Difficulty 1/5 1-3 hours Newbie friendliness 87/100
godotengine/godot-docs#12364 · 3 comments ·
-
bug content:website
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
godotengine/godot-docs#12360 · 1 comment ·
-
bug content:website
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
godotengine/godot-docs#12348 ·
All issues in godotengine/godot-docs
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100