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.

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

Minor update to documentation #101

Merged
merged 2 commits into from
Dec 12, 2024
Merged

Minor update to documentation #101

merged 2 commits into from
Dec 12, 2024

Conversation

MihaMi27
Copy link
Contributor

Updated documentation in the following ways:

  • rephrased HR to heart rate to improve clarity for users,
  • corrected typos,
  • added missing returns,
  • removed None type from returns,
  • sync return type declaration,
  • added "Note" sections where necessary.

I did not modify the MainWindow class as it is supposedly auto-generated by PyQtUI code generator.
The function update_map_component() from class Model should be further documented with parameter types. Without them, the documentation will not have the correct format and information.

I can correct the documentation once I have the correct information.

@firefly-cpp
Copy link
Owner

Thanks, this is great.

@firefly-cpp firefly-cpp merged commit d8a80f2 into firefly-cpp:main Dec 12, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants