Skip to content

DOC: Autoreformat a few files.#11596

Merged
mhvk merged 1 commit into
astropy:mainfrom
Carreau:doc-2
Apr 21, 2021
Merged

DOC: Autoreformat a few files.#11596
mhvk merged 1 commit into
astropy:mainfrom
Carreau:doc-2

Conversation

@Carreau

@Carreau Carreau commented Apr 18, 2021

Copy link
Copy Markdown
Contributor

Run velin on a few files and cherry-pick the changes that are not purely
blank lines.

See #11590 for preceding discussion;
Let me know and I can also include the blank line changes if subsequents updates.

@Carreau
DOC: Autoreformat a few files.
e4f0203 
Run velin on a few files and cherry-pick the changes that are not purely
blank lines.
@pllim pllim added this to the v4.3 milestone Apr 19, 2021
@pllim

pllim commented Apr 19, 2021 •
edited
Loading

Copy link
Copy Markdown
Member

Still not completely sold on the * and ** but the rest of the changes are uncontroversial.

@pllim pllim requested review from adrn and mhvk April 19, 2021 14:09
@Carreau

Carreau commented Apr 19, 2021

Copy link
Copy Markdown
Contributor Author

Still not completely sold on the * and **

Up to you, I can remove, numpydoc reference was recently ammended to add

When documenting variable length positional, or keyword arguments, leave the
leading star(s) in front of the name::

@pllim

pllim commented Apr 19, 2021

Copy link
Copy Markdown
Member

Thanks! I am guessing this supersedes #11590 ? Is there any reason to keep the other one open?

Up to you

Let's wait and see what others say.

@saimn

saimn commented Apr 19, 2021

Copy link
Copy Markdown
Contributor

Having the * / ** seems useful to emphasize that it's a special parameter, and if that's now standardized in numpydoc then that seems the good solution to me. (Nice tool btw @Carreau , I wish I could have used it in the past!)

mhvk
mhvk approved these changes Apr 19, 2021
View reviewed changes

@mhvk mhvk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think all changes are great now! I'm quite happy to go with the numpydoc recommendation of including * and ** (even if @Carreau made the change!), as I think it helps to make clear that these are special.

@mhvk

mhvk commented Apr 21, 2021

Copy link
Copy Markdown
Contributor

OK, let's get this in! Thanks, @Carreau!

@mhvk mhvk merged commit c6b3d20 into astropy:main Apr 21, 2021
@Carreau Carreau mentioned this pull request Apr 26, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mhvk mhvk mhvk approved these changes
@adrn adrn Awaiting requested review from adrn

Assignees

No one assigned

Labels

config convolution coordinates Docs no-changelog-entry-needed

Projects

None yet

Milestone

v4.3

Development

Successfully merging this pull request may close these issues.

4 participants

@Carreau @pllim @saimn @mhvk