Skip to content

Commit 579b3a6

Browse files
committed
more docs changes
1 parent 450b3cc commit 579b3a6

3 files changed

Lines changed: 14 additions & 10 deletions

File tree

README.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,12 @@ Brawl Stats
2626
Features
2727
~~~~~~~~
2828

29-
- Covers all of the endpoints of the API.
30-
- Use the same client for sync and async usage.
31-
- Access game constants such as maps, brawlers, and images.
3229
- Easy to use with an object oriented design.
30+
- Use the same client for sync and async usage.
31+
- Get a player profile and battlelog.
32+
- Get a club and its members.
33+
- Get the top 200 rankings for players, clubs, or a specific brawler.
34+
- Get information about maps, brawlers, and more!
3335

3436
Installation
3537
~~~~~~~~~~~~
@@ -44,7 +46,7 @@ Install the development build:
4446

4547
::
4648

47-
pip install git+https://github.com/SharpBit/brawlstats
49+
pip install git+https://github.com/SharpBit/brawlstats@development
4850

4951
Documentation
5052
~~~~~~~~~~~~~

docs/index.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,12 @@ Welcome to Brawl Stats' documentation!
1919
Features
2020
~~~~~~~~
2121

22-
- Covers all of the endpoints of both APIs.
23-
- Use the same client for sync and async usage.
24-
- Access game constants such as maps, brawlers, and images.
2522
- Easy to use with an object oriented design.
23+
- Use the same client for sync and async usage.
24+
- Get a player profile and battlelog.
25+
- Get a club and its members.
26+
- Get the top 200 rankings for players, clubs, or a specific brawler.
27+
- Get information about maps, brawlers, and more!
2628

2729
Installation
2830
~~~~~~~~~~~~

docs/logging.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ The optional ``level`` argument specifies what level of events to log
2020
out and can any of ``CRITICAL``, ``ERROR``, ``WARNING``, ``INFO``, and
2121
``DEBUG`` and if not specified defaults to ``WARNING``.
2222

23-
More advance setups are possible with the :mod:`logging` module. To for
24-
example write the logs to a file called ``brawlstars.log`` instead of
25-
outputting them to to the console the following snippet can be used
23+
More advanced setups are possible with the :mod:`logging` module. For example,
24+
to write the logs to a file called ``brawlstars.log`` instead of
25+
outputting them to to the console, the following snippet can be used:
2626

2727
.. code-block:: python
2828

0 commit comments

Comments
 (0)