search

heavenshell / vim-pydocstring

Generate Python docstring to your Python source code.
BSD 3-Clause "New" or "Revised" License
337 stars 53 forks source link

Update feature numpy #23

Closed deeuu closed 7 years ago

deeuu commented 7 years ago

Hi, I've merged the master branch and then modified the template files to improve numpy styling:

def test(param1: int, param2: str) -> str:
    """test

    Parameters
    ----------

    param1 : int
        param1 is
    param2 : str
        param2 is

    Returns
    -------

    returnVar : str
    """
heavenshell commented 7 years ago

Hi, thx for PR.

At first, do not change default template/pydocstring/multi.txt to numpy style. template/pydocstring/multi.txt is Sphinx(reST) docstring style. There are few reasons to why I adapted Sphinx docstring style.

If you want use numpy style as default, use g:pydocstring_templates_dir for set your template directory path and put your own templates.

Second, why you did not checkout branch from master. It's big change and I can't approve it.

You just want change only template files? https://github.com/heavenshell/vim-pydocstring/pull/23/commits/aeb442af58e5bb4204959c8f657d7880ac066a36

You don't need checkout from numpy branch. (I forgot to delete numpy branch...)

Thank you for sending me PR but I can't accept this. Sorry.

deeuu commented 7 years ago

Hi,

I understand that you have a preferred default, hence why I was aiming to update the feature_numpy branch (keeping master untouched). My mistake regarding the template information, I missed that.

Shall I send you a new PR with my Numpy template in vim-pydocstring/test/templates/? I figure some people might find it useful.

Thanks

heavenshell commented 7 years ago

@deeuu

Shall I send you a new PR with my Numpy template in vim-pydocstring/test/templates/? I figure some people might find it useful.

Sounds very nice! Could you send me new PR?

Thank you.