Encourage R users to check out `animovement`

neuroinformatics-unit / movement

Python tools for analysing body movements across space and time

http://movement.neuroinformatics.dev

BSD 3-Clause "New" or "Revised" License

107 stars 8 forks source link

Encourage R users to check out `animovement` #335

Closed niksirbi closed 3 weeks ago

niksirbi commented 1 month ago

Description

What is this PR

[ ] Bug fix
[ ] Addition of a new feature
[x] Documentation

Why is this PR needed?

Closes #305

What does this PR do?

Adds a "tip" admonition to the README and the website homepage. Sadly I had to duplicate the text in both places, because the syntax for creating admonition boxes is different in GitHub-flavored vs myst-markdown. We could do away with the duplication if we went for simpler rendering options, but I like how the admonitions look.

How has this PR been tested?

Local docs build.

codecov[bot] commented 1 month ago

Codecov Report

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

Project coverage is 99.76%. Comparing base (7813e7c) to head (c7356dc). Report is 1 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #335 +/- ## ======================================= Coverage 99.76% 99.76% ======================================= Files 14 14 Lines 846 846 ======================================= Hits 844 844 Misses 2 2 ```

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

niksirbi commented 4 weeks ago

Hey @sfmig, thanks for sending me down a 🐰 🕳️

I ended up writing such a script (using yours as a starting points). Not sure it's worth it, since for the sake of 2 admonitions we now have to maintain an entire script, bit I lean towards using the script anyway. My reasoning is that in the future we may build upon it to do some more intelligent parsing from README.md to index.md, in a way that further reduces duplication (not just across admonitions).