Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[DOC] Typo with back-ticks in documentation found #401

Closed
loganthomas opened this issue Jul 13, 2019 · 3 comments · Fixed by #413
Closed

[DOC] Typo with back-ticks in documentation found #401

loganthomas opened this issue Jul 13, 2019 · 3 comments · Fixed by #413
Labels
being worked on An individual has claimed this issue and would like to hack on it. docfix Documentation fixes needed good first issue Good for newcomers

Comments

@loganthomas
Copy link
Collaborator

Brief Description of Fix

Found a "back-tick" error on a page within the pyjanitor docs. I assume this should appear as pyjanitor and pandas rather than the below image shows.

Screen Shot 2019-07-13 at 10 43 34

Currently, the docs don't render backticks as code correctly.

I would like to propose a change, such that now the docs use backticks correctly.

Relevant Context
@loganthomas
Copy link
Collaborator Author

I will be fixing this issue and looking for others as well.

@sallyhong
Copy link
Collaborator

You are correct. Thank you!

@sallyhong sallyhong added being worked on An individual has claimed this issue and would like to hack on it. docfix Documentation fixes needed good first issue Good for newcomers labels Jul 13, 2019
@loganthomas
Copy link
Collaborator Author

@kulini Contributed a commit as well with the dirty data set explanation :)

@loganthomas loganthomas mentioned this issue Jul 13, 2019
Merged
9 tasks
ericmjl pushed a commit that referenced this issue Jul 13, 2019
@loganthomas @ericmjl
[DOC] Backtick doc fix #401 WIP (#413)
bbbdc51 
* [DOC] Fix back-tick rendering in pyjanitor_intro.ipynb

* Back-ticks don't render well in html when displaying in bold.
  For some reason, there is no issue with back-ticks found in titles.

* Issue fixed by deleting bold and keeping back-ticks.

* [DOC] Added better explanation of dirty data in pyjanitor_intro.ipynb

* Described messy data set with better bullet points.

* Closes #401

* Contribution by @kulini

* [DOC] Added authors @loganthomas and @kulini

* [TEST] updating fork with new merges
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
being worked on An individual has claimed this issue and would like to hack on it. docfix Documentation fixes needed good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DOC] Backtick doc fix #401 WIP
2 participants
@sallyhong @loganthomas