-
Notifications
You must be signed in to change notification settings - Fork 1k
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
[FSDEV] Update the STM32 documentation #2676
Conversation
Looking more into supported.rst ...
The hardware of both are of a full-speed USB device type. It seems that there is a confusion of what exactly the ✖ and empty box means. Currently both are used for two options:
To improve the clarity I propose changing the meaning and explanation to this:
That way, if there is any symbol present, it means that the hardware is capable of that particular feature and the symbol itself just shows the status of the software implementation. To me such an approach seems to be more useful and consistent. If the main developers agree to such a change, I could at least update this for STM32 devices and probably some other. Any comments? |
actually, I don't manage the docs well enough. The idea is
If you are user WBx5 is FS device only, please make a pr to update it. |
Also slightly updated the table legend. As there are no functional changes, despite the failing hardware test, this PR is ready to go. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
all look good, though there is a missing table format in the comment, which cause github not rendering table correcting.
Sorry for the blunder! I wasn't familiar with RST syntax and didn't pay enough attention to that smaller table. Now learned a bit about the syntax, used this online editor and it seems that the latest commit is finally correct. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
perfect, thank you. No problem with the rst, I am not familliar with it as well. I normally prefer markdown, but rst generated nice docs page/site.
Seeing the upcoming #2672, also added U535/U545 as supported.