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

Expose and improve the docstrings of export_od and import_id #473

Merged

Conversation

erlend-aasland
Copy link
Contributor

Resolves #472

@codecov-commenter
Copy link

codecov-commenter commented Jun 29, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.68%. Comparing base (503918c) to head (4dcdb38).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #473   +/-   ##
=======================================
  Coverage   67.68%   67.68%           
=======================================
  Files          26       26           
  Lines        3104     3104           
  Branches      521      521           
=======================================
  Hits         2101     2101           
  Misses        862      862           
  Partials      141      141           
Files Coverage Δ
canopen/objectdictionary/__init__.py 82.29% <100.00%> (ø)

@erlend-aasland
Copy link
Contributor Author

Docstring changes:

  • Consistent punctuation and capitalisation.
  • Mark up literals using monospaced font.
  • Remove unneeded return type annotation.
  • Use typing to autogenerate param list and return info.

@erlend-aasland erlend-aasland changed the title Expose and improve the docstrings of export_od and import_id Expose and improve the docstrings of export_od and import_id Jun 29, 2024
canopen/objectdictionary/__init__.py Outdated Show resolved Hide resolved
@erlend-aasland

This comment was marked as resolved.

@acolomb acolomb merged commit 028a57f into christiansandberg:master Jul 2, 2024
1 check passed
@erlend-aasland erlend-aasland deleted the doc/import-and-export-od branch July 2, 2024 11:22
@erlend-aasland
Copy link
Contributor Author

Thanks for the review and your insights.

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.

import_od and export_od are undocumented
3 participants