DOC: use substitution decorator for business month classes (#25828) #25868

Batalex · 2019-03-25T13:18:01Z

closes Use Substitution Decorator for CustomBusinessMonthEnd #25828
tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

Validation script
CustomBusinessMonthEnd

################################################################################
########## Docstring (pandas.tseries.offsets.CustomBusinessMonthEnd)  ##########
################################################################################
                                                                                
DateOffset subclass representing one custom business month, incrementing        
between end of month dates.                                                     
                                                                                
Parameters                                                                      
----------                                                                      
n : int, default 1                                                              
normalize : bool, default False                                                 
    Normalize start/end dates to midnight before generating date range          
weekmask : str, Default 'Mon Tue Wed Thu Fri'                                   
    weekmask of valid business days, passed to ``numpy.busdaycalendar``         
holidays : list                                                                 
    list/array of dates to exclude from the set of valid business days,         
    passed to ``numpy.busdaycalendar``                                          
calendar : pd.HolidayCalendar or np.busdaycalendar                              
offset : timedelta, default timedelta(0)                                        
                                                                                
################################################################################
################################## Validation ##################################
################################################################################
                                                                                
9 Errors found:                                                                 
        Summary should fit in a single line                                     
        Parameter "n" has no description                                        
        Parameter "normalize" description should finish with "."                
        Parameter "weekmask" description should start with a capital letter     
        Parameter "weekmask" description should finish with "."                 
        Parameter "holidays" description should start with a capital letter     
        Parameter "holidays" description should finish with "."                 
        Parameter "calendar" has no description                                 
        Parameter "offset" has no description                                   
2 Warnings found:                                                               
        See Also section not found                                              
        No examples section found

CustomBusinessMonthBegin

################################################################################
######### Docstring (pandas.tseries.offsets.CustomBusinessMonthBegin)  #########
################################################################################
                                                                                
DateOffset subclass representing one custom business month, incrementing        
between beginning of month dates.                                               
                                                                                
Parameters                                                                      
----------                                                                      
n : int, default 1                                                              
normalize : bool, default False                                                 
    Normalize start/end dates to midnight before generating date range          
weekmask : str, Default 'Mon Tue Wed Thu Fri'                                   
    weekmask of valid business days, passed to ``numpy.busdaycalendar``         
holidays : list                                                                 
    list/array of dates to exclude from the set of valid business days,         
    passed to ``numpy.busdaycalendar``                                          
calendar : pd.HolidayCalendar or np.busdaycalendar                              
offset : timedelta, default timedelta(0)                                        
                                                                                
################################################################################
################################## Validation ##################################
################################################################################
                                                                                
9 Errors found:                                                                 
        Summary should fit in a single line                                     
        Parameter "n" has no description                                        
        Parameter "normalize" description should finish with "."                
        Parameter "weekmask" description should start with a capital letter     
        Parameter "weekmask" description should finish with "."                 
        Parameter "holidays" description should start with a capital letter     
        Parameter "holidays" description should finish with "."                 
        Parameter "calendar" has no description                                 
        Parameter "offset" has no description                                   
2 Warnings found:                                                               
        See Also section not found                                              
        No examples section found

codecov · 2019-03-25T13:56:14Z

Codecov Report

Merging #25868 into master will decrease coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #25868      +/-   ##
==========================================
- Coverage   91.48%   91.48%   -0.01%     
==========================================
  Files         175      175              
  Lines       52885    52885              
==========================================
- Hits        48381    48380       -1     
- Misses       4504     4505       +1

Flag	Coverage Δ
#multiple	`90.04% <100%> (ø)`	⬆️
#single	`41.82% <100%> (ø)`	⬆️

Impacted Files	Coverage Δ
pandas/tseries/offsets.py	`96.69% <100%> (ø)`	⬆️
pandas/util/testing.py	`89.74% <0%> (-0.11%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 923ac2b...540e18e. Read the comment docs.

WillAyd

Thanks for the PR! Substitution looks correct. The docstring errors are orthogonal but do you see an easy way to fix them? May be worth knocking out as part of this if simple

doc/source/whatsnew/v0.25.0.rst

Batalex · 2019-03-25T17:49:51Z

@WillAyd I juste force pushed somes changes:

Removed uneeded entry in whatsnew
Fixed isort linting
Fixed docstring validation. I picked some description elements from offsets.DateOffset & np.busdaycalendar

WillAyd

Nice job! FYI for next contribution shouldn't need to force push changes so long as you merge in master

pandas/tseries/offsets.py

…v#25828)

…offset

WillAyd

Very minor stuff. If you can clean up and ping on green can get this merged

pandas/tseries/offsets.py

WillAyd · 2019-03-26T15:22:36Z

@Batalex just to clarify previous comment force pushing is less than desirable. Assuming you are rebasing which requires a force push an alternate workflow on top of your local branch is:

git fetch upstream
git merge upstream/master

Resolve any conflicts and git merge --continue if applicable. Should then be able to push without forcing

…offset

WillAyd

lgtm ping on green

Batalex · 2019-03-26T17:02:44Z

@WillAyd ping

WillAyd · 2019-03-26T17:09:44Z

Thanks @Batalex !

Batalex · 2019-03-26T17:20:43Z

Thanks for your guidance!

WillAyd requested changes Mar 25, 2019

View reviewed changes

doc/source/whatsnew/v0.25.0.rst Outdated Show resolved Hide resolved

WillAyd added the Docs label Mar 25, 2019

Batalex force-pushed the doc/substitution-offset branch 4 times, most recently from be8c313 to d5c50d3 Compare March 25, 2019 17:43

WillAyd approved these changes Mar 25, 2019

View reviewed changes

WillAyd requested changes Mar 25, 2019

View reviewed changes

pandas/tseries/offsets.py Outdated Show resolved Hide resolved

WillAyd requested changes Mar 25, 2019

View reviewed changes

pandas/tseries/offsets.py Outdated Show resolved Hide resolved

Batalex added 2 commits March 26, 2019 09:17

DOC: use substitution decorator for business month classes (pandas-de…

f6959d3

…v#25828)

Merge remote-tracking branch 'upstream/master' into doc/substitution-…

8df84fb

…offset

Batalex force-pushed the doc/substitution-offset branch from d5c50d3 to 8df84fb Compare March 26, 2019 08:19

WillAyd requested changes Mar 26, 2019

View reviewed changes

pandas/tseries/offsets.py Outdated Show resolved Hide resolved

pandas/tseries/offsets.py Outdated Show resolved Hide resolved

Batalex added 2 commits March 26, 2019 16:52

Merge remote-tracking branch 'upstream/master' into doc/substitution-…

0e8d9cb

…offset

DOC: reword custom business month offset args descriptions

540e18e

WillAyd approved these changes Mar 26, 2019

View reviewed changes

WillAyd added this to the 0.25.0 milestone Mar 26, 2019

WillAyd merged commit d404460 into pandas-dev:master Mar 26, 2019

Batalex deleted the doc/substitution-offset branch March 27, 2019 07:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: use substitution decorator for business month classes (#25828) #25868

DOC: use substitution decorator for business month classes (#25828) #25868

Batalex commented Mar 25, 2019 •

edited

Loading

codecov bot commented Mar 25, 2019 •

edited

Loading

WillAyd left a comment

Batalex commented Mar 25, 2019

WillAyd left a comment

WillAyd left a comment

WillAyd commented Mar 26, 2019

WillAyd left a comment

Batalex commented Mar 26, 2019

WillAyd commented Mar 26, 2019

Batalex commented Mar 26, 2019

DOC: use substitution decorator for business month classes (#25828) #25868

DOC: use substitution decorator for business month classes (#25828) #25868

Conversation

Batalex commented Mar 25, 2019 • edited Loading

codecov bot commented Mar 25, 2019 • edited Loading

Codecov Report

WillAyd left a comment

Choose a reason for hiding this comment

Batalex commented Mar 25, 2019

WillAyd left a comment

Choose a reason for hiding this comment

WillAyd left a comment

Choose a reason for hiding this comment

WillAyd commented Mar 26, 2019

WillAyd left a comment

Choose a reason for hiding this comment

Batalex commented Mar 26, 2019

WillAyd commented Mar 26, 2019

Batalex commented Mar 26, 2019

Batalex commented Mar 25, 2019 •

edited

Loading

codecov bot commented Mar 25, 2019 •

edited

Loading