Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation Improvement #110

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Documentation Improvement #110

wants to merge 14 commits into from

Conversation

masoudabedinifar
Copy link
Collaborator

Dear @rmndrs89 and @JuliusWelzel ,

Could you please review the improvements in the documentation? If they meet your requirements, could you please merge the branch into the main branch?
Thank you!

Best regards,
Masoud

@codecov Codecov
Copy link

codecov bot commented Nov 12, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.42%. Comparing base (bb8172b) to head (0185add).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #110   +/-   ##
=======================================
  Coverage   87.42%   87.42%           
=======================================
  Files          23       23           
  Lines        2863     2863           
=======================================
  Hits         2503     2503           
  Misses        360      360

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JuliusWelzel
Copy link
Contributor

JuliusWelzel commented Nov 12, 2024 •
edited by masoudabedinifar
Loading

Hi,

a few minor changes.

  • Note box

    KielMAT/docs/index.md

    Line 152 in c366fd8

    > [!NOTE]

    Does not render in the documentation properly

  • The tables on the index page should be markdown formatted.

  • Units For the units, please provide the accompanying channel types:

    KielMAT/docs/index.md

    Line 86 in c366fd8

    ## Units

  • dataclass update the documentation for the dataclass, all functions should show in the mermaid overview:

    KielMAT/docs/dataclass.md

    Line 6 in c366fd8

    ## KielMAT data class

  • return the return for the turn detection detect function does not render correctly in the documentation:

    KielMAT/docs/modules/td.md

    Line 3 in c366fd8

    ::: modules.td._pham.PhamTurnDetection

  • progressbar the documentation for the fetch_dataset function says there is a progressbar available, which is not in the documentation:

    KielMAT/docs/datasets/keepcontrol.md

    Line 7 in c366fd8

    ::: datasets.keepcontrol

all minor warning from the mkdocs autochcker:

  • WARNING- griffe: kielmat\utils\kielmat_dataclass.py:94: No type or annotation for returned value 'str'
  • WARNING - griffe: kielmat\modules\ptd_pham.py:90: Parameter 'min_turn_angle_deg' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\importers.py:19: No type or annotation for returned value 1
  • WARNING - griffe: kielmat\utils\importers.py:76: Parameter 'tracked_point' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\quaternion.py:294: Parameter 'scalar_first' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\quaternion.py:296: Parameter 'channels_last' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:443: Parameter 'input_array' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:175: No type or annotation for parameter '**kwargs'
  • WARNING - griffe: kielmat\utils\preprocessing.py:178: No type or annotation for returned value 1
  • WARNING - griffe: kielmat\utils\preprocessing.py:85: Parameter 'param' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:1092: Parameter 'Data' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:1093: Parameter 'Window' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:1096: No type or annotation for returned value 1

@masoudabedinifar
Copy link
Collaborator Author

Hi @JuliusWelzel ,

Thanks for the valuable feedback. I have tried to address all the concerns and have committed the revisions in 218949f . Could you please check the revisions, and if they meet the requirements, merge the branch into the main branch?
Thanks!

Best,
Masoud

JuliusWelzel
JuliusWelzel reviewed Nov 13, 2024
View reviewed changes
docs/dataclass.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mermaid dataclass diagram has not changed

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Handled here: 0185add

kielmat/datasets/keepcontrol.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not add it to the code but remove the progress bar from the documentation

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is handled here: 73bad3e

kielmat/modules/ptd/_pham.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does still not render properly:
image

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Handled in 5514104

kielmat/modules/td/_pham.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still not rendered properly:
image

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Handled in 5514104

kielmat/utils/importers.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to change the docstring of this function

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Handled here e6a4ab1

kielmat/utils/kielmat_dataclass.py
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not correct:
image

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Handled here: 7026ba2

mkdocs.yml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should not be example with the same number. Maybe we can name them 1-8

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Handled here: 3a21b36

@JuliusWelzel
Copy link
Contributor

JuliusWelzel commented Nov 13, 2024 •
edited by masoudabedinifar
Loading

I also got more warning from mkdocs:

  • WARNING - griffe: kielmat\utils\kielmat_dataclass.py:94: No type or annotation for returned value 'str'
  • WARNING - griffe: kielmat\modules\ptd_pham.py:90: Parameter 'min_turn_angle_deg' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\importers.py:19: No type or annotation for returned value 1
  • WARNING - griffe: kielmat\utils\importers.py:76: Parameter 'tracked_point' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\quaternion.py:294: Parameter 'scalar_first' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\quaternion.py:296: Parameter 'channels_last' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:443: Parameter 'input_array' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:175: No type or annotation for parameter '**kwargs'
  • WARNING - griffe: kielmat\utils\preprocessing.py:178: No type or annotation for returned value 1
  • WARNING - griffe: kielmat\utils\preprocessing.py:85: Parameter 'param' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:1092: Parameter 'Data' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:1093: Parameter 'Window' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:1096: No type or annotation for returned value 1

@JuliusWelzel
Copy link
Contributor

Could you please check the revisions, and if they meet the requirements, merge the branch into the main branch?

For the future, please make sure you can run mkdocs serve and check the rendering yourself.

@masoudabedinifar
Copy link
Collaborator Author

I also got more warning from mkdocs:

  • WARNING - griffe: kielmat\utils\kielmat_dataclass.py:94: No type or annotation for returned value 'str'
  • WARNING - griffe: kielmat\modules\ptd_pham.py:90: Parameter 'min_turn_angle_deg' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\importers.py:19: No type or annotation for returned value 1
  • WARNING - griffe: kielmat\utils\importers.py:76: Parameter 'tracked_point' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\quaternion.py:294: Parameter 'scalar_first' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\quaternion.py:296: Parameter 'channels_last' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:443: Parameter 'input_array' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:175: No type or annotation for parameter '**kwargs'
  • WARNING - griffe: kielmat\utils\preprocessing.py:178: No type or annotation for returned value 1
  • WARNING - griffe: kielmat\utils\preprocessing.py:85: Parameter 'param' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:1092: Parameter 'Data' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:1093: Parameter 'Window' does not appear in the function signature
  • WARNING - griffe: kielmat\utils\preprocessing.py:1096: No type or annotation for returned value 1

I handled all these warnings and I do not get them when I render locally.

@masoudabedinifar
Copy link
Collaborator Author

@JuliusWelzel Thanks for the feedback. I handled all the reviews and locally rendered them without any warnings.

JuliusWelzel
JuliusWelzel approved these changes Nov 14, 2024
View reviewed changes
Copy link
Contributor

@JuliusWelzel JuliusWelzel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am happy with the changes, maybe @rmndrs89 can also review. Once done, we are good to go

rmndrs89
rmndrs89 reviewed Dec 6, 2024
View reviewed changes
kielmat/utils/preprocessing.py
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do **kwargs need to be specified as a dictionary? See here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JuliusWelzel JuliusWelzel JuliusWelzel approved these changes

@rmndrs89 rmndrs89 rmndrs89 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@masoudabedinifar @JuliusWelzel @rmndrs89