Issue #58812 : DOC : Added doc string to announce.py and contibutors.py #58826
Conversation
There was a problem hiding this comment.
Amazing work! I think this is a bit overkill though, in my opinion only the summary should be kept because this is a command line script so we don't really need to explain how to use these functions. Or maybe don't include the examples section which takes a lot of space
doc/sphinxext/announce.py
Outdated
| @@ -57,6 +57,34 @@ | |||
|
|
|||
|
|
|||
| def get_authors(revision_range): | |||
| """ | |||
| Extract authors from a range of revisions | |||
There was a problem hiding this comment.
| Extract authors from a range of revisions | |
| Extract authors from a range of revisions. |
Can you make sure there's a dot after every short summary?
|
@Aloqeely Okay so should i remove the long summary or examples from doc string |
|
iirc this file is vendored so we wouldn’t want to edit it |
|
@jbrockmendel Sorry im new to this, can you give me some more detail about what to do, i didn't understand |
Ah, I didn't know that. After further search it seems most of the copied code is from scipy |
We can edit it, but generally don't. If someone thinks there is an improvement to be made in this file, it should be done upstream. |
|
@Aloqeely I have removed the examples from doc string and added full stop to the shot summary, is there any other change that needs to be made? |
|
@malhar2460 I am sorry but as mentioned here, this file is vendored so it isn't touched very often and I don't think we're gonna update it just to add the docstrings. Really sorry for taking much of your time! On a note I'm still OK with this going through since the functions here are different from the ones upstream, but leaving final decision for @jbrockmendel |
|
Okay, np👍🏻 |
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.