diff options
author | Karl Lorey <git@karllorey.com> | 2022-06-20 22:26:28 +0200 |
---|---|---|
committer | Karl Lorey <git@karllorey.com> | 2022-06-20 22:26:28 +0200 |
commit | bb9435b07da8a33f20e8b1321960b19e4e27b847 (patch) | |
tree | 8788b1995c22d2eaf5ea20bafe505af1e03c0f33 | |
parent | 25f776acf2173dbbb431ee9b4d36e0aec29b5fdf (diff) |
Fix docs
-rw-r--r-- | CONTRIBUTING.rst | 28 | ||||
-rw-r--r-- | HISTORY.rst | 4 | ||||
-rw-r--r-- | docs/index.rst | 1 |
3 files changed, 13 insertions, 20 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ff9bd54..5d25656 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -21,7 +21,8 @@ If you are reporting a bug, please include: * Your operating system name and version. * Any details about your local setup that might be helpful in troubleshooting. -* Detailed steps to reproduce the bug. +* Detailed steps to reproduce the bug, in particular the HTML of the scraped pages. +* A minimal repository replicating the bug is much appreciated. Again, with HTML. Fix Bugs ~~~~~~~~ @@ -38,9 +39,10 @@ and "help wanted" is open to whoever wants to implement it. Write Documentation ~~~~~~~~~~~~~~~~~~~ -mlscraper could always use more documentation, whether as part of the -official mlscraper docs, in docstrings, or even on the web in blog posts, -articles, and such. +mlscraper could always use more documentation, +whether as part of the official mlscraper docs, in docstrings, +or even on the web in blog posts, articles, and such. +If you do something, reach out to me, so I can promote your work: https://github.com/lorey Submit Feedback ~~~~~~~~~~~~~~~ @@ -79,11 +81,9 @@ Ready to contribute? Here's how to set up `mlscraper` for local development. 5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:: - $ flake8 mlscraper tests - $ python setup.py test or pytest $ tox - To get flake8 and tox, just pip install them into your virtualenv. + To get the development requirements, use :code:`pip install -r requirements/tests.txt` and :code:`pip install -r requirements.dev.txt` 6. Commit your changes and push your branch to GitHub:: @@ -102,17 +102,7 @@ Before you submit a pull request, check that it meets these guidelines: 2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst. -3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check - https://travis-ci.com/lorey/mlscraper/pull_requests - and make sure that the tests pass for all supported Python versions. - -Tips ----- - -To run a subset of tests:: - -$ pytest tests.test_mlscraper - +3. The pull request should work for Python 3.9+ and for PyPy. Deploying --------- @@ -125,4 +115,4 @@ $ bump2version patch # possible: major / minor / patch $ git push $ git push --tags -Travis will then deploy to PyPI if tests pass. +Github will then deploy the package to PyPI. diff --git a/HISTORY.rst b/HISTORY.rst index 136ac54..b84f97d 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -5,7 +5,9 @@ History ------------------ UPCOMING ------------------ - +* scrapers can now extract arbitrary data structure including list, dict, and string objects +* scrapers now work for multiple pages by default +* the module structure has been revised ------------------ 0.1.2 (2020-09-27) diff --git a/docs/index.rst b/docs/index.rst index 23b7d64..dcd50a1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,6 +11,7 @@ Welcome to mlscraper's documentation! contributing authors history + modules Indices and tables ================== |