Update ANISE docs#41
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly expands the Python API documentation for the ANISE library, including the addition of the Quaternion class and numerous methods and constants across the constants, rotation, and time modules. Feedback focuses on correcting typos and grammatical errors, ensuring consistency in type hints (specifically using numpy.ndarray), and aligning documentation argument names with function signatures.
| ##### Variable `rot_mat_dt` {#anise.rotation.DCM.rot_mat_dt} | ||
|
|
||
| :rtype: numpy.array | ||
| Return the time derivative of this DMC, if set. |
There was a problem hiding this comment.
Typo: "DMC" should be "DCM" (Direction Cosine Matrix).
| Return the time derivative of this DMC, if set. | |
| Return the time derivative of this DCM, if set. |
| > ) | ||
|
|
||
| Returns the angular velocity vector in deg/s if a rotation rate is defined. | ||
| :rtype: np.array |
There was a problem hiding this comment.
For consistency with other type hints in this file (e.g., lines 52, 58, 204), use numpy.ndarray instead of np.array.
| :rtype: np.array | |
| :rtype: numpy.ndarray |
| * <code>from</code> - The ID of the source frame. | ||
| * <code>to</code> - The ID of the destination frame. |
There was a problem hiding this comment.
The argument names in the documentation list should match the function signature (from_id and to_id).
| * <code>from</code> - The ID of the source frame. | |
| * <code>to</code> - The ID of the destination frame. | |
| * <code>from_id</code> - The ID of the source frame. | |
| * <code>to_id</code> - The ID of the destination frame. |
| > / | ||
| > ) | ||
|
|
||
| Convert this quaterion to a DCM |
There was a problem hiding this comment.
Typo: "quaterion" should be "quaternion".
| Convert this quaterion to a DCM | |
| Convert this quaternion to a DCM |
| > time_scale=None | ||
| > ) | ||
|
|
||
| Converts the Epoch to the Gregorian parts in the (optionally) provided time scale as (year, month, day, hour, minute, second). |
There was a problem hiding this comment.
The description of the Gregorian parts is missing the nanosecond component, which is included in the return type hint (7 integers).
| Converts the Epoch to the Gregorian parts in the (optionally) provided time scale as (year, month, day, hour, minute, second). | |
| Converts the Epoch to the Gregorian parts in the (optionally) provided time scale as (year, month, day, hour, minute, second, nanosecond). |
| > / | ||
| > ) | ||
|
|
||
| Returns the Barycentric Coordinate Time (TCB) as a Duration its reference epoch (1977-01-01 + 65.5 µs) |
There was a problem hiding this comment.
Grammar: Missing "since" or "from" before "its reference epoch". This also applies to lines 2712, 2723, and 2734.
| Returns the Barycentric Coordinate Time (TCB) as a Duration its reference epoch (1977-01-01 + 65.5 µs) | |
| Returns the Barycentric Coordinate Time (TCB) as a Duration since its reference epoch (1977-01-01 + 65.5 µs) |
| and the number of nanoseconds elapsed in current week (since closest Sunday midnight). | ||
| This is usually how GNSS receivers describe a timestamp. | ||
| :rtype: typing.Tuple[int] | ||
| :rtype: tuple |
There was a problem hiding this comment.
For consistency with other tuple type hints (e.g., line 153), specify the tuple components for to_time_of_week.
| :rtype: tuple | |
| :rtype: tuple[int, int] |
| > other | ||
| > ) | ||
|
|
||
| Returns a copy of self where the hours, minutes, seconds is set to the time of the provided epoch but the |
There was a problem hiding this comment.
Grammar: "hours, minutes, seconds is set" should be "hours, minutes, and seconds are set".
| Returns a copy of self where the hours, minutes, seconds is set to the time of the provided epoch but the | |
| Returns a copy of self where the hours, minutes, and seconds are set to the time of the provided epoch but the |
|
Visit the preview URL for this PR (updated for commit 4fa963c): https://nyx-space--pr41-update-docs-dt8zifo9.web.app (expires Wed, 20 May 2026 04:42:10 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: ecf6068ed4b2d3d429c02e3ebe5890356e4315eb |
1 participant
No description provided.