Usage guide edit #18819
Usage guide edit #18819
Conversation
jeromefv
force-pushed
the
usage_guide_edit
branch
from
65a03d7 to
99ddafb
Compare
tutorials/introductory/usage.py
Outdated
| # input. Classes that are 'array-like' such as `pandas` data objects | ||
| # and `numpy.matrix` may or may not work as intended. It is best to | ||
| # input. Classes that are similar to arrays such as `pandas` data objects | ||
| # and `numpy.matrix` may not work as intended. Common convention is to |
There was a problem hiding this comment.
You can remove numpy.matrix. That class is not recommended anymore by numpy itself, and rarely used in practice nowadays. - Also the matrix example code below.
There was a problem hiding this comment.
I think this is a bit too strong, we do test that pandas works correctly in some cases and special case extracting the index and label when it makes sense.
| # can be defined e.g. in the :file:`matplotlibrc` file (see | ||
| # :doc:`/tutorials/introductory/customizing` for more information about | ||
| # the :file:`matplotlibrc` file). :rc:`path.simplify` is a boolean | ||
| # the :file:`matplotlibrc` file). :rc:`path.simplify` is a Boolean |
There was a problem hiding this comment.
Found some inconsistencies in the Python docs, Built-in Types use the capital "B" and Boolean Objects does not.
|
@jeromefv Ping me if you want a hand with the rebase. |
|
👋 @jeromefv are you still planning on finishing this? I think it just needs a rebase. If not, I'm happy to finish it off instead. |
|
Thank you, @dstansby! I'll work on it today and rebase with the changes. I'll ping any folks if I run into issues. Thank you for the update! |
jeromefv
force-pushed
the
usage_guide_edit
branch
from
35a69e3 to
29d35d4
Compare
|
Overall, a revamp of this document would fit more in line with how I'd like to create consistency between this and the |
That's a good point! If @dstansby will/wants to take over and do bigger sweeping changes, then it makes a lot of sense for me to sit out here. Originally, this PR was more of a "practice" for me to get an idea of how I can shape the language to better fit the explanations. I think if I were to tackle this PR again, I'd do a large restructuring project with explanations similar to what GSoD was. I don't think I'd be able to do that in a prompt timeline at the moment, however. |
|
@story645 you were blocking on this. |
7 participants
PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).