Comments (3)
I think this is a pybind11-stubgen bug in disguise. The docstring in the AST of the stub wouldn't match the actual docstring.
from sphinxify.
Hm? The original content has a \#
and the content output by sphinxify also has a \#
? How is that a stubgen bug?
from sphinxify.
Here's a real example that doesn't involve sphinxify:
This produces the following in the .pyi:
class SwerveDrive4PoseEstimator(SwerveDrive4PoseEstimatorBase):
"""
This class wraps Swerve Drive Odometry to fuse latency-compensated
vision measurements with swerve drive encoder distance measurements. It is
intended to be a drop-in for :class:`SwerveDriveOdometry`.
:meth:`update` should be called every robot loop.
:meth:`addVisionMeasurement` can be called as infrequently as you want; if you
never call it, then this class will behave as regular encoder odometry.
The state-space system used internally has the following states (x) and outputs (y):
:math:`x = [x, y, \theta]^T` in the field-coordinate system
containing x position, y position, and heading.
:math:`y = [x, y, \theta]^T` from vision containing x position, y
position, and heading; or :math:`y = [theta]^T` containing gyro
heading.
"""
Here the \t
is being interpreted as a tab, since the backslash isn't escaped in any way. pydoc
correctly preserves the backslash, so the __doc__
is correct, but the .pyi contents are not.
from sphinxify.
Related Issues (12)
- bug HOT 2
- Doc thing is cool, but does it need to create an ordered dict every time?
- HTML stripping leaves extra spaces?
- Handle in/out styled parameters
- Doc.get_param should return typing.Optional[Param]
- Javadoc links aren't always handled
- Support Doxygen deprecated tag HOT 1
- Doesn't handle @note correctly? HOT 2
- Enum text broken HOT 1
- Handle inline tags that span multiple lines HOT 4
- Escape words that end in _
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sphinxify.