Skip to content

Update docs and examples#1421

Merged
zariiii9003 merged 1 commit into
hardbyte:developfrom
zariiii9003:update_docs
Oct 30, 2022
Merged

Update docs and examples#1421
zariiii9003 merged 1 commit into
hardbyte:developfrom
zariiii9003:update_docs

Conversation

@zariiii9003

Copy link
Copy Markdown
Collaborator

I tried to make to the docs slightly less confusing for beginners.

  • add all public methods to the documentation of can.Bus. The documentation of can.BusABC is moved from Bus to Internal API
  • add a proper documentation of the interface argument and update the examples to use interface instead of bustype. Link to the list of all interfaces in configuration.rst
  • add missing interfaces to configuration.rst
  • improve documentation of the plugin interface. Add a recommendation to use the plugin interface to development.rst

@codecov

codecov Bot commented Oct 28, 2022

Copy link
Copy Markdown

Codecov Report

Merging #1421 (793463c) into develop (4b43f33) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1421      +/-   ##
===========================================
- Coverage    65.28%   65.28%   -0.01%     
===========================================
  Files           81       81              
  Lines         8777     8779       +2     
===========================================
+ Hits          5730     5731       +1     
- Misses        3047     3048       +1     

@hardbyte hardbyte left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Great job

Comment thread doc/interfaces.rst
Comment on lines +45 to +46
Plugin Interface
^^^^^^^^^^^^^^^^

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

💯

@zariiii9003 zariiii9003 merged commit d3103d8 into hardbyte:develop Oct 30, 2022
@zariiii9003 zariiii9003 deleted the update_docs branch October 30, 2022 22:25
j-c-cook added a commit to j-c-cook/python-can that referenced this pull request Nov 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants