Skip to content
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

Import docs from Google Code Archive #25

Closed
hugovk opened this issue Feb 2, 2020 · 2 comments · Fixed by #42
Closed

Import docs from Google Code Archive #25

hugovk opened this issue Feb 2, 2020 · 2 comments · Fixed by #42
Labels
docs Documentation help wanted Extra attention is needed

Comments

@hugovk
Copy link
Member

hugovk commented Feb 2, 2020

The README says:

This tutorial is distributed with PrettyTable and is meant to serve
as a "quick start" guide for the lazy or impatient. It is not an
exhaustive description of the whole API, and it is not guaranteed to be
100% up to date. For more complete and update documentation, check the
PrettyTable wiki.

The wiki is on the old Google Code Archive:

And links to two pages:

Let's move those to this repo as versioned MD or RST files.

There may be some overlap between the tutorial and the README, if so, perhaps they could be merged. Or create a new file for it.

Installation is short and out of date, it says to use easy_install, or to manually copy the file to certain directories for different operating systems (with python2.5 in the examples!). This could be replaced with modern pip install ... info near the top of the README.

@hugovk hugovk added bug Something isn't working docs Documentation help wanted Extra attention is needed and removed bug Something isn't working labels Feb 2, 2020
@andreykurilin
Copy link

@hugovk cloud.google.com stores these pages in markdown. Here is Tutorial.wiki.
I tried to quickly compare the sections of ReadMe and Tutorial page: they provide the similar info (ReadMe misses information about from_html method).
As for installation - I guess, there is no reason to import Installation.wiki page. It can be rewritten with one command that should cover all modern systems pip install PrettyTable :)

@hugovk
Copy link
Member Author

hugovk commented Apr 16, 2020

@andreykurilin Thank you very much for checking! I think we probably remove the link in the README to the wiki then.

Yeah, pip install PrettyTable can replace Installation.wiki! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants