Skip to content

DOC: re-phrase web README.md ENG #48720

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.

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 2 commits into from
Sep 23, 2022
Merged

Conversation

anonmouse1
Copy link
Contributor

Basic rephrasing of the web README.md for improved legibility

  • "to navigate it " -> "to allow navigation of the website " ("it" is ambiguous here, "website" leaves no question as to which entity the instructions refer to.
  • "it is needed" -> "must"
  • "a not open" -> "it is not possible to open " (perhaps a typo here initially, sentence lengthened for improved legibility)

web/README.md Outdated
@@ -5,8 +5,8 @@ containing the settings to build the website. The website is generated with the
command `./pandas_web.py pandas`. See `./pandas_web.py --help` and the header of
the script for more information and options.

After building the website, to navigate it, it is needed to access the web using
an http server (a not open the local files with the browser, since the links and
After building the website, the web must be accessed using
Copy link
Member

Choose a reason for hiding this comment

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

Maybe just:

After building the website, a local http sever is needed to access the built website (it is ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good suggestion, updated to reflect refinement.

@mroeschke mroeschke added Docs Web pandas website labels Sep 23, 2022
@mroeschke mroeschke added this to the 1.6 milestone Sep 23, 2022
@mroeschke mroeschke merged commit 5763023 into pandas-dev:main Sep 23, 2022
@mroeschke
Copy link
Member

Thanks @anonmouse1

@mroeschke mroeschke modified the milestones: 1.6, 2.0 Oct 13, 2022
noatamir pushed a commit to noatamir/pandas that referenced this pull request Nov 9, 2022
* update wording readme.md

* refine http server instruction
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Web pandas website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants