Skip to content

Conversation

@hardbyte
Copy link
Owner

@hardbyte hardbyte commented Nov 15, 2022

Mostly just editing wording and trying to fix any funky rendering.

A few minor edits to content, and now a bit more restructuring.

Follows on from the great work in #1421

@hardbyte hardbyte changed the title Quick pass through all interface docs Documentation update for 4.1.0 Nov 15, 2022
@hardbyte hardbyte requested a review from zariiii9003 November 15, 2022 09:53
@hardbyte hardbyte added this to the 4.1.0 Release milestone Nov 15, 2022
@zariiii9003
Copy link
Collaborator

There are a few new warnings:

/home/runner/work/python-can/python-can/doc/interfaces/udp_multicast.rst:18: WARNING: undefined label: 'other_virtual_interfaces'
/home/runner/work/python-can/python-can/can/interfaces/udp_multicast/bus.py:docstring of can.interfaces.udp_multicast.bus.UdpMulticastBus:18: WARNING: undefined label: 'other_virtual_interfaces'
/home/runner/work/python-can/python-can/can/interfaces/virtual.py:docstring of can.interfaces.virtual.VirtualBus:12: WARNING: undefined label: 'other_virtual_interfaces'
/home/runner/work/python-can/python-can/can/io/logger.py:docstring of can.io.logger.Logger:4: WARNING: py:class reference target not found: can.TRCWriter

@zariiii9003
Copy link
Collaborator

While you're at it, could you take a look at this? This should fix the readthedocs PR integration

@zariiii9003
Copy link
Collaborator

What do you think about moving these into separate files? So they just appear in the table of contents like Bus, Message etc...
image

@zariiii9003
Copy link
Collaborator

The docs look much more well rounded now, i like these changes a lot.

Something that i'm still not super happy about is this:

The BusABC class, as the name suggests, provides an abstraction of a CAN bus. The bus provides a wrapper around a physical or virtual CAN Bus. An interface specific instance of the BusABC is created by the Bus class, for example:

Talking about abstract base classes isn't a great intro for beginners imo. This is probably the first paragraph that a new user will look at.

@hardbyte hardbyte requested a review from zariiii9003 November 16, 2022 01:25
Copy link
Collaborator

@zariiii9003 zariiii9003 left a comment

Choose a reason for hiding this comment

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

looks good 👍

@hardbyte hardbyte merged commit 2e2f157 into develop Nov 16, 2022
@hardbyte hardbyte deleted the docs-spring-clean branch November 16, 2022 08:43
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.

3 participants