Skip to content

[DOC] Add list mark to keep select_columns's example same style #888

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 23, 2021
Merged

[DOC] Add list mark to keep select_columns's example same style #888

merged 2 commits into from
Aug 23, 2021

Conversation

Zeroto521
Copy link
Member

PR Description

Please describe the changes proposed in the pull request:

As title.
When I read select_columns's doc, I found the 3329 line missing the list mark.

pyjanitor/janitor/functions.py

Lines 3322 to 3329 in b806e29

- Select by string::
df.select_columns("id")
id
0 0
1 1
Select via shell-like glob strings (*) is possible::

PR Checklist

Please ensure that you have done the following:

  1. PR in from a fork off your branch. Do not PR from <your_username>:dev, but rather from <your_username>:<feature-branch_name>.
  1. If you're not on the contributors list, add yourself to AUTHORS.rst.
  1. Add a line to CHANGELOG.md under the latest version header (i.e. the one that is "on deck") describing the contribution.
    • Do use some discretion here; if there are multiple PRs that are related, keep them in a single line.

Automatic checks

There will be automatic checks run on the PR. These include:

  • Building a preview of the docs on Netlify
  • Automatically linting the code
  • Making sure the code is documented
  • Making sure that all tests are passed
  • Making sure that code coverage doesn't go down.

Relevant Reviewers

Please tag maintainers to review.

@Zeroto521
Copy link
Member Author

Zeroto521 commented Aug 23, 2021

Should 3290 line change to .. code-block:: python ?
But this doesn't seem any effect on HTML.

pyjanitor/janitor/functions.py

Lines 3287 to 3292 in b806e29

Examples
--------
::
import pandas as pd

@codecov
Copy link

codecov bot commented Aug 23, 2021

Codecov Report

Merging #888 (11b7186) into dev (b806e29) will increase coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##              dev     #888      +/-   ##
==========================================
+ Coverage   95.62%   95.66%   +0.04%     
==========================================
  Files          19       19              
  Lines        2444     2444              
==========================================
+ Hits         2337     2338       +1     
+ Misses        107      106       -1     

@ericmjl
Copy link
Member

ericmjl commented Aug 23, 2021

@Zeroto521 thank you for handling this!

@ericmjl
Copy link
Member

ericmjl commented Aug 23, 2021

@Zeroto521 thank you very much!

@ericmjl ericmjl merged commit ea8e006 into pyjanitor-devs:dev Aug 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants