From 023d7618c6bbc6eec6b939b9109f006ee9137e76 Mon Sep 17 00:00:00 2001 From: Tyler Barrus Date: Tue, 21 Apr 2020 23:09:04 -0400 Subject: [PATCH] update changelog --- CHANGELOG.md | 2 +- CONTRIBUTING.md | 18 +++++++++--------- README.rst | 10 +++++++--- 3 files changed, 17 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 210d327..98ab273 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,7 +11,7 @@ ## Version 0.6.2 -* Add `allpages` functionaloty [PR #75](https://github.com/barrust/mediawiki/pull/75) +* Add `allpages` functionality [PR #75](https://github.com/barrust/mediawiki/pull/75) * Add `langlinks` page property [PR #76](https://github.com/barrust/mediawiki/pull/76) ## Version 0.6.1 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 72489d4..9a9f283 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ bugs and issues, request enhancements, and issue pull requests. #### Issues and Bug Reports -If you have found an issue with pymediawiki, please do not hesitate to let us +If you have found an issue with `pymediawiki`, please do not hesitate to let us know! Before submitting an issue or bug report, we ask that you complete a few cursory items: @@ -38,8 +38,8 @@ quickly. trying to which you are trying to connect. There are times where the MediaWiki site may refuse connections or throw an error. There are times when trying again is all that is needed! If the error is the MediaWiki site, please do not -report an issue as there is nothing we can do to help. If it is something -within the library, please do not hesitate to report the issue! +report an issue as there is nothing we can do to help. If, however it is +something within the library, please do not hesitate to report the issue! * **Determine** that the issue is reproducible - a code sample of the issue will help narrow down the search for the cause of the issue and may lead to a @@ -60,14 +60,14 @@ with syntax highlighting * The link to the API URL if not the default: [Wikipedia API](http://en.wikipedia.org/w/api.php) -* The affected version(s) of pymediawiki +* The affected version(s) of `pymediawiki` #### Enhancements Enhancements are additional functionality not currently supported by the -pymediawiki library. Unfortunately, not all enhancements make sense for the +`pymediawiki` library. Unfortunately, not all enhancements make sense for the goal of the project. If you have a desired feature, there are a few things you -can do to possibly help get the feature into the pymediawiki library: +can do to possibly help get the feature into the `pymediawiki` library: * **Review** to see if the feature has been requested in the past. @@ -140,11 +140,11 @@ The MediaWiki API wrapper project also uses [pylint](https://www.pylint.org/) to help identify potential errors, code duplication, and non-pythonic syntax. Adhering to pylint's results is not strictly required. -To install the [PEP8 compliance checker](https://pypi.python.org/pypi/pep8), +To install the [PEP8 compliance checker](https://pypi.org/project/pycodestyle/), you can simply run the following: ``` -pip install pep8 +pip install pycodestyle ``` To test for PEP8 compliance, run the following from the root directory: @@ -155,7 +155,7 @@ pep8 mediawiki ### Code Contributors: -A special thanks to all the code contributors to pymediawiki! +A special thanks to all the code contributors to `pymediawiki`! [@barrust](https://github.com/barrust) (Maintainer) diff --git a/README.rst b/README.rst index 0a065f3..50eab78 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,12 @@ MediaWiki ========= + +.. image:: https://img.shields.io/badge/license-MIT-blue.svg + :target: https://opensource.org/licenses/MIT/ + :alt: License +.. image:: https://img.shields.io/github/release/barrust/mediawiki.svg + :target: https://GitHub.com/Naereen/StrapDown.js/releases/ + :alt: GitHub release .. image:: https://badge.fury.io/py/pymediawiki.svg :target: https://badge.fury.io/py/pymediawiki .. image:: https://travis-ci.org/barrust/mediawiki.svg?branch=master @@ -11,9 +18,6 @@ MediaWiki .. image:: https://api.codacy.com/project/badge/Grade/afa87d5f5b6e4e66b78e15dedbc097ec :target: https://www.codacy.com/app/barrust/mediawiki?utm_source=github.com&utm_medium=referral&utm_content=barrust/mediawiki&utm_campaign=Badge_Grade :alt: Codacy Review -.. image:: https://img.shields.io/badge/license-MIT-blue.svg - :target: https://opensource.org/licenses/MIT/ - :alt: License .. image:: http://pepy.tech/badge/pymediawiki :target: http://pepy.tech/count/pymediawiki :alt: Downloads