DOC: Add pip install odfpy for io.rst
#50498
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phofl
reviewed
Dec 30, 2022
doc/source/user_guide/io.rst
Outdated
| @@ -3833,7 +3833,7 @@ OpenDocument Spreadsheets | |||
| The io methods for `Excel files`_ also support reading and writing OpenDocument spreadsheets | |||
| using the `odfpy <https://pypi.org/project/odfpy/>`__ module. The semantics and features for reading and writing | |||
| OpenDocument spreadsheets match what can be done for `Excel files`_ using | |||
| ``engine='odf'``. | |||
| ``engine='odf'``. ``pip install odfpy`` may be required, if is not already installed. | |||
There was a problem hiding this comment.
It's sufficient if you add a comment that users have to install the optional dependency oddly, pip install is not necessary.
There was a problem hiding this comment.
I replaced it with a comment, and this time?
phofl
reviewed
Dec 30, 2022
doc/source/user_guide/io.rst
Outdated
| @@ -3840,6 +3840,7 @@ The :func:`~pandas.read_excel` method can read OpenDocument spreadsheets | |||
| .. code-block:: python | |||
|
|
|||
| # Returns a DataFrame | |||
| # package 'odfpy' is required | |||
There was a problem hiding this comment.
I would add The optional dependency 'odfpy' needs to be installed in line 3836
phofl
approved these changes
Dec 30, 2022
|
thx @luke396 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #50487
Perhaps because of my misunderstanding, adding 'pip install' here may not be consistent with the previous docs style. Because there is no direct instruction in the previous docs how to install the engine manually.