Comments (2)
dadadel
commented on August 15, 2024
Hi @graik,
Pyment is supposed to manage raise and thus to convert from reST to google.
Can you provide an example? I will try to fix this.
from pyment.
dadadel
commented on August 15, 2024
I close this issue as raise seems to work.
For instance:
def func1(param1):
"""Description
:param param1: foo
:raises Exception: my exception
:returns: the return value
"""
passWill produce:
def func1(param1):
"""Description
- :param param1: foo
- :raises Exception: my exception
- :returns: the return value
+ Args:
+ param1: foo
+
+ Returns:
+ the return value
+
+ Raises:
+ Exception my exception
+
"""
passfrom 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.