JuliaGeometry / JuliaGeometry/CoordinateTransformations.jl

Document that for spherical coordinates theta is going from x to y and phi is going from xy-plane to z

Open
#25 17 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
185
Forks
24
PR merge metrics
No merged PRs in 30d

Description

Document that for spherical coordinates theta is going from x to y and phi is going from xy-plane to z.

This definition of phi differs from the mathematically defined phi:
https://en.wikipedia.org/wiki/Spherical_coordinate_system

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the repository documentation for its spherical-coordinate definitions and read the surrounding explanation. Document that theta increases from x toward y and phi increases from the xy-plane toward z, noting that this differs from the mathematical convention linked in the issue; confirm the wording is clear and consistent with the existing documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.