From 52496260b31cd5116eeb89adeee7498d91708846 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Sun, 11 Jan 2026 03:48:22 +0000 Subject: [PATCH] Proofread and fix documentation content - Fix formatting in `docs/anise/explanation/index.md` - Fix typo "ex-exports" to "re-exports" in `docs/anise/explanation/time.md` - Fix typo "high profile" to "high-profile" in `docs/anise/explanation/validation.md` - Fix duplicate text and return statement formatting in `docs/anise/reference/analysis-api.md` - Fix German word "sowohl" in `docs/anise/reference/orbit.md` --- docs/anise/explanation/index.md | 3 +-- docs/anise/explanation/time.md | 2 +- docs/anise/explanation/validation.md | 2 +- docs/anise/reference/analysis-api.md | 7 +------ docs/anise/reference/orbit.md | 2 +- 5 files changed, 5 insertions(+), 11 deletions(-) diff --git a/docs/anise/explanation/index.md b/docs/anise/explanation/index.md index ce1d1da..3ca2a34 100644 --- a/docs/anise/explanation/index.md +++ b/docs/anise/explanation/index.md @@ -7,6 +7,5 @@ This section delves into the design of ANISE, its architecture, and the core con - **[Almanac and Context](almanac-and-context.md)**: Understanding the data-driven design and thread safety. - **[Frame Safety](frame-safety.md)**: How ANISE prevents coordinate system errors. - **[Analysis Engine](analysis.md)**: Declarative queries and superlinear event finding. -- **[Time](time.md)**: The importance of high-precision timekeeping. -- **[Validation](validation.md)**: How we ensure accuracy against SPICE.nanosecond precision without rounding errors. +- **[Time](time.md)**: The importance of high-precision timekeeping, achieving nanosecond precision without rounding errors. - **[Validation](validation.md)**: How we ensure ANISE matches (or exceeds) the accuracy of the SPICE toolkit. \ No newline at end of file diff --git a/docs/anise/explanation/time.md b/docs/anise/explanation/time.md index 488acf9..f5e732f 100644 --- a/docs/anise/explanation/time.md +++ b/docs/anise/explanation/time.md @@ -22,4 +22,4 @@ ANISE re-exports Hifitime as-is for convenience to avoid adding a package to you use anise::time::*; ``` -_Note:_ In Python, you must use the ex-exports instead of the Hifitime classes imported from the `hifitime` package because the Python interpreter does not know that both classes are in fact identical. \ No newline at end of file +_Note:_ In Python, you must use the re-exports instead of the Hifitime classes imported from the `hifitime` package because the Python interpreter does not know that both classes are in fact identical. \ No newline at end of file diff --git a/docs/anise/explanation/validation.md b/docs/anise/explanation/validation.md index 08a03d6..38c951d 100644 --- a/docs/anise/explanation/validation.md +++ b/docs/anise/explanation/validation.md @@ -2,4 +2,4 @@ ANISE undergoes a rigorous validation process, meticulously detailed in the Validation step linked above. This comprehensive workflow involves running parallel queries in both ANISE and SPICE (in single-threaded test mode using the `rust-spice` crate by Grégoire Henry) for precise comparison. -Specifically, it includes the validation of 101,000 BSP queries against the DE440.BSP file. Additionally, we validate 7,305 queries for each frame in the PCK08 file, covering every day across a span of 20 years. This is complemented by an extensive series of rotations from the Earth's high-precision BPC file. This thorough and detailed validation process ensures that ANISE meets the highest standards of accuracy and reliability as expected by high profile missions. \ No newline at end of file +Specifically, it includes the validation of 101,000 BSP queries against the DE440.BSP file. Additionally, we validate 7,305 queries for each frame in the PCK08 file, covering every day across a span of 20 years. This is complemented by an extensive series of rotations from the Earth's high-precision BPC file. This thorough and detailed validation process ensures that ANISE meets the highest standards of accuracy and reliability as expected by high-profile missions. \ No newline at end of file diff --git a/docs/anise/reference/analysis-api.md b/docs/anise/reference/analysis-api.md index a45c9b5..19cbc48 100644 --- a/docs/anise/reference/analysis-api.md +++ b/docs/anise/reference/analysis-api.md @@ -40,7 +40,7 @@ A dictionary (or map) where keys are Epochs and values are maps of `{ "Alias": V # Add optional aliases (Tuple of (Scalar, Alias)) scalars_with_aliases = [(s, None) for s in scalars] - + # Build the final report object report = analysis.ReportScalars(scalars_with_aliases, state) @@ -117,11 +117,6 @@ A list of `EventArc` objects, each containing: ) ``` -**Returns:** -A list of `EventArc` objects, each containing: -- `start`: The `EventDetails` of the start (Rising edge). -- `end`: The `EventDetails` of the end (Falling edge). - ## Common Expressions ### Vector Expressions diff --git a/docs/anise/reference/orbit.md b/docs/anise/reference/orbit.md index 3a73496..ccc60ed 100644 --- a/docs/anise/reference/orbit.md +++ b/docs/anise/reference/orbit.md @@ -30,7 +30,7 @@ Defines a state relative to a body's surface. Useful for ground stations. ### `transform_to` `almanac.transform_to(orbit, target_frame, aberration)` -Returns a new `Orbit` expressed in the `target_frame`. This accounts for sowohl translation as well as rotation of the frames. +Returns a new `Orbit` expressed in the `target_frame`. This accounts for both translation as well as rotation of the frames. ### Orbital Elements You can extract orbital elements from an `Orbit` object: