glotzerlab / glotzerlab/coxeter
Update docs for `maximal_[centered|]_bounded_sphere`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 25
- Forks
- 5
- Avg merge
- 9m
- Merged PRs (30d)
- 3
Description
Feature description
Confusion often arises between the maximal bounded sphere and the minimal bounding sphere.
Proposed solution
The docs for these properties should be updated to be more specific. Perhaps graphical examples could be given to clarify the confusing wording. insphere_from_center (the previous property name) is perhaps more misleading - an "insphere", which by Coxeter's definition must be tangent to every face, is not the same as the general bounded sphere discussed above.
Contributor guide
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.
Research direction
Locate the documentation for maximal_[centered|]_bounded_sphere and the previous insphere_from_center property name. Clarify the distinction between a maximal bounded sphere, a minimal bounding sphere, and an insphere; graphical examples are suggested but not required by the issue.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100