Comments (6)
Hi @naiquevin , happy new year ! What do you think of my proposal ? I think using a real python backend to generate the docstring can be much more powerful than using the the elisp code we currently have. It can also handle more cases and also more styles (it currently supports google
, numpy
, reST
).
from sphinx-doc.el.
Hi @wizmer Happy new year to you too. I missed your earlier message, sorry about that. I don't mind the change you are proposing. But IMO, it'd be good if the current implementation of generating docstring in elisp is also supported as a fallback in case pydocstring is not installed in the environment. What do you think?
from sphinx-doc.el.
Have you guys considered pyment
? seems more active project than pydocstring
and IIUIC does the same thing isn't it?
from sphinx-doc.el.
@naiquevin Yes, I think keeping a fallback option would be nice.
@zzantares Thanks for your suggestion, I was not aware of pyment
, it seems indeed more active and also more complete. I'll give it a try.
from sphinx-doc.el.
On the emacs side of things there's also https://github.com/glyph/python-docstring-mode, unfortunately unmaintained currently.
Bringing it up because it's tangentially related. It also uses its own implementation. Perhaps there's room to build something that does both?
from sphinx-doc.el.
I have started refactoring pyment
here dadadel/pyment#112
I also plan to enhance it and make it more customizable.
That will be for the backend side but when I'll be done with it, it will be time to think whether to integrate it in sphinx-doc
or build a new package if it goes too much beyond sphinx-doc
scope. Also, sphinx-doc
name suggests that it is only for sphinx docstring while pyment
is able to handle more styles.
from sphinx-doc.el.
Related Issues (20)
- Melpe stable HOT 3
- Support for PEP 3107 HOT 1
- Updating docstring fails if fully qualified types specified in :param directive HOT 1
- Add support for automatic indentation of param documentation
- Error when inserting docstring; inserting docstring kills any existing docstring HOT 7
- Is there any plan for google style sphinx doc?
- Any idea about integrating this repo into spacemacs.d? HOT 2
- Plan to support napoleon sphinx docstring? HOT 1
- Support trailing commas? HOT 2
- Doesn’t include anything if there is a comment after the function header
- This is a great package. But are you going to support docstring for class? HOT 2
- System fails if type hints are present HOT 3
- Feature request: numpydoc syntax HOT 2
- Failure when the default value is a string with the % symbol
- How can I ignore new-line after param or returns?
- Does it support adding comments in swift? HOT 1
- [help/question] rst skeletons?
- Feature request: Skeleton for modules and classes HOT 1
- option to include :type info field instead of just :param HOT 7
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 sphinx-doc.el.