seafloor-geodesy / gnatss

Community Seafloor Global Navigation Satellite Systems - Acoustic (GNSS-A) Transponder Surveying Software
https://gnatss.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
9 stars 12 forks source link

Update docs #290

Closed johnbdesanto closed 1 week ago

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 76.20%. Comparing base (c4a2ece) to head (8b4e6fa).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #290 +/- ## ======================================= Coverage 76.20% 76.20% ======================================= Files 29 29 Lines 1786 1786 ======================================= Hits 1361 1361 Misses 425 425 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

johnbdesanto commented 1 week ago

@lsetiawan Thanks for merging this. However, upon review I've noticed that the math in the GNSS-A preprocessing page (specifically the section on the Kalman filter) is off. I've verified that the "prettier" bot is automatically replacing the underscores meant to subscript the parenthesis for many variables. Basically, in the current page (https://gnatss.readthedocs.io/en/latest/gnssa_preprocessing.html) any "*" character has been inserted by the bot and is erroneous.

lsetiawan commented 1 week ago

Oh I see. Oops sorry if I merged this prematurely. Please create another PR for additional fixes. Thanks

johnbdesanto commented 1 week ago

The issue is a little more complex with that. I can't currently submit a new PR because I can't pass all of the checks required to make a new commit. Here is the context:

I wrote the code $$ Y_{(k|k-1)} = \Phi_{(k|k-1)} \cdot Y_{(k-1|k-1)} $$ in markdown, which should be transcribed to

$$ Y{(k|k-1)} = \Phi{(k|k-1)} \cdot Y_{(k-1|k-1)} $$

The pre-commit check fails and re-writes this as $$ Y*{(k|k-1)} = \Phi*{(k|k-1)} \cdot Y\_{(k-1|k-1)} $$, which renders as

$$ Y{(k|k-1)} = \Phi{(k|k-1)} \cdot Y_{(k-1|k-1)} $$

So I need a way to overwrite the pre-commit bot that is erroneously screwing with the markdown.