neuroinformatics-unit / movement

Python tools for analysing body movements across space and time
http://movement.neuroinformatics.dev
BSD 3-Clause "New" or "Revised" License
96 stars 8 forks source link

Remove monospace formatting from 'movement' on website #266

Closed lochhh closed 1 month ago

lochhh commented 1 month ago

Description

What is this PR

Why is this PR needed? While working on #264 I noticed on the website, we sometimes use movement, but more often we use the un-styled 'movement'. Perhaps we could stick with the latter which simplifies the documentation process (NumPy and pandas do this as well).

What does this PR do? This PR removes monospace formatting from 'movement' on the website (mostly .md files, except for the examples .py files). The monospace-formatting in the docstrings (API reference) remains unchanged.

How has this PR been tested?

Docs built locally and on CI

Notes

This PR is branched off #264 and needs rebasing.

Checklist:

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 (e7ccfe5) to head (d9c53aa). Report is 7 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #266 +/- ## ======================================= Coverage 99.76% 99.76% ======================================= Files 14 14 Lines 866 866 ======================================= Hits 864 864 Misses 2 2 ```

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

sonarcloud[bot] commented 1 month ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

niksirbi commented 1 month ago

Let's discuss this during the next meeting, because I'm also unsure. Like Sofia, I like the popping out of movement and it also helps to differentiate the package from the colloquial use of the word "movement" (NumPy and Pandas don't have this problem). On the other hand, it's hard to remember to consistently do it every time. Even if we document these stylistic choices in the contributing guide, few will read it or remember to do it every time (thus increasing reviewing labour).

It would be nice to have a linting rule or a hook of some sorts. Maybe this is a good prompt to start using vale.sh for "editorial" linting?

lochhh commented 1 month ago

Closing as we agreed to stick with movement in favour of clarity but opened #279 to document "soft" rules regarding this.