Comments (7)
Thanks @patkujawa-wf for reporting that issue. I will try to fix it ASAP.
from pyment.
@patkujawa-wf a first way to address your problem is to write :returns:
instead of :return:
as returns is the expected syntax in reST format as you can notice in the link you provided.
But the observed behaviour using your example is clearly buggy! And worth I noticed that inverting :rtype:
line with :return:
line will remove both lines!
from pyment.
Thanks @dadadel! I wonder why PyCharm autocompletes on :return:
? I've definitely see that in other docstrings, too, but good to know! :)
from pyment.
@dadadel I'm confused, now, since http://sphinx-doc.org/domains.html#info-field-lists has an example that uses :return:
, not :returns:
. So which is correct?
.. py:function:: send_message(sender, recipient, message_body, [priority=1])
Send a message to a recipient
:param str sender: The person sending the message
:param str recipient: The recipient of the message
:param str message_body: The body of the message
:param priority: The priority of the message, can be a number 1-5
:type priority: integer or None
:return: the message id
:rtype: int
:raises ValueError: if the message_body exceeds 160 characters
:raises TypeError: if the message_body is not a basestring
from pyment.
Both are correct, return is an alias for returns:
https://github.com/sphinx-doc/sphinx/blob/2ec179044bc7dfc647731a08bc3da7d6e133c994/sphinx/domains/c.py#L69
https://github.com/sphinx-doc/sphinx/blob/5f63aac209b0d23420ddb6374673ed13dd7ec4b2/doc/ext/napoleon.rst#L110
found this while running test suites, I'll take a look at it too
edit: added pull request #28
from pyment.
@maqifrnswa Thanks for your fix. I updated your test commit.
from pyment.
The issue is fixed by the PR #28.
from pyment.
Related Issues (20)
- PyPi Package Update HOT 4
- Please add example on how to specify output format HOT 2
- Type annotations cause converted docstrings to break HOT 2
- It does not work with raw docstring HOT 1
- Is this project still maintained ? HOT 1
- Removes stub docstrings
- Messes up tabs
- Fails to recognize \n line ending files and is using \r\n under Windows
- No support for async functions HOT 1
- Crash on nested square brackets in type annotation
- Feature Request: docstring style for sphinx-autodoc-typehints HOT 1
- Broken docstring HOT 2
- Pyment not respecting type annotations
- Treats r-strings incorrectly
- Breaking existing numpy docstring.
- Feature Request: Publish/Deploy Sphinx Documentation Website
- Conversions Adds Type Hints to Google Style Docstrings.
- Wrong docstring when complex types are used like Callable[...]
- UnicodeDecodeError charmap (On Windows) HOT 1
- Type is removed from parameter if not in type hints when converting reST docstring
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 pyment.