Skip to content

DOC: Improve options.rst #46124

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 1 commit into from
Feb 26, 2022
Merged

DOC: Improve options.rst #46124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Binary file removed doc/source/_static/option_unicode01.png
View file
Open in desktop
Binary file not shown.
Binary file removed doc/source/_static/option_unicode02.png
View file
Open in desktop
Binary file not shown.
Binary file removed doc/source/_static/option_unicode03.png
View file
Open in desktop
Binary file not shown.
Binary file removed doc/source/_static/option_unicode04.png
View file
Open in desktop
Binary file not shown.
327 changes: 49 additions & 278 deletions doc/source/user_guide/options.rst
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 2 additions & 6 deletions doc/source/whatsnew/v0.17.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,16 +363,12 @@ Some East Asian countries use Unicode characters its width is corresponding to 2
.. ipython:: python
df = pd.DataFrame({u"国籍": ["UK", u"日本"], u"名前": ["Alice", u"しのぶ"]})
df;
.. image:: ../_static/option_unicode01.png
df
.. ipython:: python
pd.set_option("display.unicode.east_asian_width", True)
df;
.. image:: ../_static/option_unicode02.png
df
For further details, see :ref:`here <options.east_asian_width>`

Expand Down
8 changes: 8 additions & 0 deletions pandas/_config/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,8 @@ def __doc__(self):
Notes
-----
Please reference the :ref:`User Guide <options>` for more information.
The available options with its descriptions:
{opts_desc}
Expand Down Expand Up @@ -323,6 +325,8 @@ def __doc__(self):
Notes
-----
Please reference the :ref:`User Guide <options>` for more information.
The available options with its descriptions:
{opts_desc}
Expand Down Expand Up @@ -355,6 +359,8 @@ def __doc__(self):
Notes
-----
Please reference the :ref:`User Guide <options>` for more information.
The available options with its descriptions:
{opts_desc}
Expand Down Expand Up @@ -385,6 +391,8 @@ def __doc__(self):
Notes
-----
Please reference the :ref:`User Guide <options>` for more information.
The available options with its descriptions:
{opts_desc}
Expand Down