You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I've implemented a Python module using PyO3: autosar-data
That worked great, using PyO3 is a pleasure.
However the documentation was written by hand in markdown (it is rendered by mkdocs).
I'm not really satisfied with it, at least compared to the high standard set by rustdoc for rust documentation.
It is written by hand instead of derived (somehow) from the implementation
there are no doctests
the formatting is not great (this is might just a be skill issue, if I'm using mkdocs incorrectly)
I would appreciate any suggestions that improve any or all of these points.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
I've implemented a Python module using PyO3: autosar-data
That worked great, using PyO3 is a pleasure.
However the documentation was written by hand in markdown (it is rendered by mkdocs).
I'm not really satisfied with it, at least compared to the high standard set by rustdoc for rust documentation.
I would appreciate any suggestions that improve any or all of these points.
Beta Was this translation helpful? Give feedback.
All reactions