DOC: Fixed outdated doc-string, added missing default values, added missing optional parameters for some io classes #11098
Conversation
|
@terrytangyuan The changes look good, but, the |
| right boundary for range (defaults to today) | ||
| retry_count : int, default 3 | ||
| Number of times to retry query request. | ||
| pause : int, default 0.001 |
There was a problem hiding this comment.
this should be float I assume? (or 'numeric')
|
@jorisvandenbossche Nice catch! Thanks for checking. I've made the changes. I'll submit another PR to make changes on the new file. |
|
@jorisvandenbossche On green now. Can you merge? |
| @@ -400,26 +405,26 @@ def get_data_yahoo(symbols=None, start=None, end=None, retry_count=3, | |||
| ---------- | |||
| symbols : string, array-like object (list, tuple, Series), or DataFrame | |||
| Single stock symbol (ticker), array-like object of symbols or | |||
| DataFrame with index containing stock symbols. | |||
| DataFrame with index containing stock symbols, default: None | |||
There was a problem hiding this comment.
Should be two lines above?
There was a problem hiding this comment.
@kawochen Do you mean the default: None?
There was a problem hiding this comment.
Yes. On line 406 instead (not sure but it looks like that's how other function parameters are documented)?
…issing optional parameters for some io classes (+1 squashed commit) Squashed commits: [7851d88] DOC: Fixed outdated doc-string, added missing default values, added missing optional parameters for some io classes (+1 squashed commit) Squashed commits: [1a77b43] DOC: Fixed outdated doc-string, added missing default values, added missing optional parameters for some io classes (+1 squashed commit) Squashed commits: [739945e] DOC: Fixed outdated doc-string, added missing default values, added missing optional parameters for some io classes
|
Thanks @kawochen Fixed and on green now. |
|
I guess this is fine. @terrytangyuan prob strip off the stuff for |
DOC: Fixed outdated doc-string, added missing default values, added missing optional parameters for some io classes
Some doc-strings are outdated, in a sense that there are missing newly added optional parameters and default values.