Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for Numpy style documentation for python #3

Closed
paulkass opened this issue Jun 26, 2019 · 2 comments
Closed

Add support for Numpy style documentation for python #3

paulkass opened this issue Jun 26, 2019 · 2 comments
Assignees
Labels
feature New feature or request

Comments

@paulkass
Copy link
Contributor

Is your feature request related to a problem? Please describe.
My project uses Numpy documentation style, and I would like to continue using that.

Describe the solution you'd like
An option to add documentation styles, in particular the Numpy documentation style.

Additional context
Here is the description of the Numpy doc style.

@paulkass paulkass added the feature New feature or request label Jun 26, 2019
@kkoomen
Copy link
Owner

kkoomen commented Jun 26, 2019

The general idea here is to add support for multiple doc styles and I definitely agree! This was something I had on my own todo list as well to implement, but it was optionally for me personally. I'll work on a multi-doc implementation per language ;)

Thanks for your input.

@kkoomen
Copy link
Owner

kkoomen commented Jun 27, 2019

Multiple doc standard are supported, tested and successfully merged into the master branch 🎉

You can overwrite the python doc standard by doing this in your vimrc:

let g:doge_doc_standard_python = 'numpy'

For more info, see https://github.com/kkoomen/vim-doge#choosing-a-different-doc-standard

@kkoomen kkoomen closed this as completed Jun 27, 2019
kkoomen added a commit that referenced this issue Jul 12, 2019
kkoomen added a commit that referenced this issue Jul 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants