Skip to content

Doc updates #865

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

Merged
merged 12 commits into from
Aug 13, 2021
Merged

Doc updates #865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c238a1a
[DOC] update link in CHANGELOG to reflect pyjanitor-devs
loganthomas Aug 12, 2021
dd3f703
[DOC] add period to end sentence in PRs link
loganthomas Aug 12, 2021
47f45d6
[DOC] update links in doc_fix template to reflect pyjanitor-devs
loganthomas Aug 12, 2021
cdb4f24
[DOC] update link in test_convert_currency.py to reflect pyjanitor-devs
loganthomas Aug 12, 2021
406d8ef
[DOC] update url in setup.py to reflect pyjanitor-devs
loganthomas Aug 12, 2021
535db1c
[DOC] update AUTHORS with new devs in leads section
loganthomas Aug 12, 2021
82b80b5
[DOC] update pivot_wider() so only first line is shown in online docs
loganthomas Aug 12, 2021
9f89fa6
[DOC] update CHANGELOG with pyjanitor-dev anchors for version diffs
loganthomas Aug 12, 2021
bb4761a
[DOC] update CHANGELOG with doc updates line
loganthomas Aug 12, 2021
fe53a0a
Merge branch 'dev' into doc-updates
loganthomas Aug 13, 2021
84056a7
[DOC] strip as_categorical from general_functions.rst
loganthomas Aug 13, 2021
a6ad1ad
[DOC] strip as_categorical from janitor/functions.py
loganthomas Aug 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation_fix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ I would like to propose a change, such that now the docs...
<!-- Please put here, in bullet points, links to the relevant docs page. A few starting template points are available
to get you started. -->

- [Link to documentation page](http://ericmjl.github.io/pyjanitor)
- [Link to exact file to be edited](https://github.com/ericmjl/pyjanitor/AUTHORS.rst)
- [Link to documentation page](https://pyjanitor-devs.github.io/pyjanitor/)
- [Link to exact file to be edited](https://github.com/pyjanitor-devs/pyjanitor/blob/dev/AUTHORS.rst)
8 changes: 4 additions & 4 deletions AUTHORS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ Leads
- Started pyspark sub-module.
- `@anzelpwj <https://github.com/anzelpwj>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/pulls?utf8=%E2%9C%93&q=is%3Aclosed+mentions%3Aanzelpwj>`_
- `@samukweku <https://github.com/samukweku>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/pulls?utf8=%E2%9C%93&q=is%3Aclosed+mentions%3Asamukweku>`_
- `@loganthomas <https://github.com/loganthomas>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3Aloganthomas>`_
- Helped others with ``git`` issues at SciPy 2019.
- `@nvamsikrishna05 <https://github.com/nvamsikrishna05>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3Anvamsikrishna05>`_
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 thank you for handling this, @loganthomas!



Contributors
Expand Down Expand Up @@ -64,8 +67,6 @@ Contributors
- `@rebeccawperry <https://github.com/rebeccawperry>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/pulls?utf8=%E2%9C%93&q=is%3Aclosed+mentions%3Arebeccawperry>`_
- `@TomMonks <https://github.com/TomMonks>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/pulls?utf8=%E2%9C%93&q=is%3Aclosed+mentions%3Atommonks>`_
- `@benjaminjack <https://github.com/benjaminjack>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/pulls?utf8=%E2%9C%93&q=is%3Aclosed+mentions%3Abenjaminjack>`_
- `@loganthomas <https://github.com/loganthomas>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3Aloganthomas>`_
- Helped others with ``git`` issues at SciPy 2019.
- `@kulini <https://github.com/kulini>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/pulls?utf8=%E2%9C%93&q=is%3Aclosed+mentions%3Akulini>`_
- `@dwgoltra <https://github.com/dwgoltra>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/pulls?utf8=%E2%9C%93&q=is%3Aclosed+mentions%3Adwgoltra>`_
- `@shandou <https://github.com/shandou>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/pulls?utf8=%E2%9C%93&q=is%3Aclosed+mentions%3Ashandou>`_
Expand Down Expand Up @@ -99,5 +100,4 @@ Contributors
- `@Sousa8697 <https://github.com/Sousa8697>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3ASousa8697>`_
- `@MollyCroke <https://github.com/MollyCroke>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3AMollyCroke>`_
- `@ericclessantostv <https://github.com/ericlessantostv>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3Aericclessantostv>`_
- `@nvamsikrishna05 <https://github.com/nvamsikrishna05>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3Anvamsikrishna05>`_
- `@fireddd <https://github.com/fireddd>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3fireddd>`_
- `@fireddd <https://github.com/fireddd>`_ | `contributions <https://github.com/pyjanitor-devs/pyjanitor/issues?q=is%3Aclosed+mentions%3Afireddd>`_
37 changes: 18 additions & 19 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
- [ENH] Add function to remove constant columsn. @fireddd
- [ENH] Added `factorize_columns` method which will deprecate the `label_encode` method in future release. @nvamsikrishna05
- [DOC] Delete Read the Docs project and remove all readthedocs.io references from the repo. Issue #863. @loganthomas
- [DOC] Updated various documentation sources to reflect pyjanitor-dev ownership. @loganthomas

## [v0.21.0] - 2021-07-16

Expand Down Expand Up @@ -214,9 +215,7 @@

For changes that happened prior to v0.18.1,
please consult the closed PRs,
which can be found here\_.

.. \_here: <https://github.com/ericmjl/pyjanitor/pulls?q=is%3Apr+is%3Aclosed>
which can be found [here](https://github.com/pyjanitor-devs/pyjanitor/pulls?q=is%3Apr+is%3Aclosed).

We thank all contributors
who have helped make `pyjanitor`
Expand All @@ -226,34 +225,34 @@ the package that it is today.

[v0.21.0]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.20.14...v0.21.0

[v0.20.14]: https://github.com/ericmjl/pyjanitor/compare/v0.20.13...v0.20.14
[v0.20.14]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.20.13...v0.20.14

[v0.20.13]: https://github.com/ericmjl/pyjanitor/compare/v0.20.12...v0.20.13
[v0.20.13]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.20.12...v0.20.13

[v0.20.12]: https://github.com/ericmjl/pyjanitor/compare/v0.20.11...v0.20.12
[v0.20.12]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.20.11...v0.20.12

[v0.20.11]: https://github.com/ericmjl/pyjanitor/compare/v0.20.10...v0.20.11
[v0.20.11]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.20.10...v0.20.11

[v0.20.10]: https://github.com/ericmjl/pyjanitor/compare/v0.20.9...v0.20.10
[v0.20.10]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.20.9...v0.20.10

[v0.20.9]: https://github.com/ericmjl/pyjanitor/compare/v0.20.8...v0.20.9
[v0.20.9]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.20.8...v0.20.9

[v0.20.8]: https://github.com/ericmjl/pyjanitor/compare/v0.20.7...v0.20.8
[v0.20.8]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.20.7...v0.20.8

[v0.20.7]: https://github.com/ericmjl/pyjanitor/compare/v0.20.5...v0.20.7
[v0.20.7]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.20.5...v0.20.7

[v0.20.6]: https://github.com/ericmjl/pyjanitor/compare/v0.20.5...v0.20.7
[v0.20.6]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.20.5...v0.20.7

[v0.20.5]: https://github.com/ericmjl/pyjanitor/compare/v0.20.1...v0.20.5
[v0.20.5]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.20.1...v0.20.5

[v0.20.1]: https://github.com/ericmjl/pyjanitor/compare/v0.20.0...v0.20.1
[v0.20.1]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.20.0...v0.20.1

[v0.20.0]: https://github.com/ericmjl/pyjanitor/compare/v0.19.0...v0.20.0
[v0.20.0]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.19.0...v0.20.0

[v0.19.0]: https://github.com/ericmjl/pyjanitor/compare/v0.18.3...v0.19.0
[v0.19.0]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.18.3...v0.19.0

[v0.18.3]: https://github.com/ericmjl/pyjanitor/compare/v0.18.2...v0.18.3
[v0.18.3]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.18.2...v0.18.3

[v0.18.2]: https://github.com/ericmjl/pyjanitor/compare/v0.18.1...v0.18.2
[v0.18.2]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.18.1...v0.18.2

[v0.18.1]: https://github.com/ericmjl/pyjanitor/compare/v0.18.0...v0.18.1
[v0.18.1]: https://github.com/pyjanitor-devs/pyjanitor/compare/v0.18.0...v0.18.1
1 change: 0 additions & 1 deletion docs/reference/general_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,3 @@ Other
complete
pivot_longer
pivot_wider
as_categorical
12 changes: 6 additions & 6 deletions janitor/functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -568,7 +568,7 @@ def encode_categorical(
parameter::

df = (pd.DataFrame(...)
.as_categorical(
.encode_categorical(
col1 = ([3, 2, 1, 4], "appearance"),
col2 = (['a','d','c','b'], "sort")
)
Expand Down Expand Up @@ -600,7 +600,7 @@ def encode_categorical(
what the arguments to the function are::

df = (pd.DataFrame(...)
.as_categorical(
.encode_categorical(
col1 = As_Categorical(
categories = [3, 2, 1, 4],
order = "appearance"
Expand Down Expand Up @@ -6235,11 +6235,11 @@ def pivot_wider(
fill_value: Optional[Union[int, float, str]] = None,
) -> pd.DataFrame:
"""
Reshapes data from long to wide form. The number of columns are
increased, while decreasing the number of rows.
Reshapes data from 'long' to 'wide' form.

It is the inverse of the `pivot_longer` method, and is a
wrapper around `pd.DataFrame.pivot` method.
The number of columns are increased, while decreasing
the number of rows. It is the inverse of the `pivot_longer`
method, and is a wrapper around `pd.DataFrame.pivot` method.

This method does not mutate the original DataFrame.

Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ def generate_long_description() -> str:
description="Tools for cleaning pandas DataFrames",
author="pyjanitor devs",
author_email="[email protected]",
url="https://github.com/ericmjl/pyjanitor",
url="https://github.com/pyjanitor-devs/pyjanitor",
license="MIT",
# packages=["janitor", "janitor.xarray", "janitor.spark"],
packages=find_packages(),
Expand Down
2 changes: 1 addition & 1 deletion tests/finance/test_convert_currency.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def test_make_currency_api_request():
tests to fail.

For an example of how this test fails, see:
https://github.com/ericmjl/pyjanitor/issues/147
https://github.com/pyjanitor-devs/pyjanitor/issues/147
"""
r = requests.get("https://api.exchangeratesapi.io")
assert r.status_code == 200
Expand Down