Skip to content

Commit

Permalink
Minor docs improvements.
Browse files Browse the repository at this point in the history
  • Loading branch information
jab committed Jul 16, 2022
1 parent 55e6a50 commit b394e88
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 19 deletions.
14 changes: 6 additions & 8 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,14 @@ Changelog
:alt: Sponsors on GitHub


Release Notifications
---------------------
:sup:`If you or your organization depends on bidict,
please consider sponsoring bidict on GitHub.`

.. duplicated in README.rst
(would use `.. include::` but GitHub doesn't understand it)

Tip:
`Watch <https://github.blog/changelog/2018-11-27-watch-releases/>`__ releases
`on GitHub <https://github.com/jab/bidict>`__
to be notified when new versions of bidict are released.
.. tip::
Watch `bidict releases on GitHub <https://github.com/jab/bidict/releases>`__
to be notified when new versions of bidict are published.
Click the "Watch" dropdown, choose "Custom", and then choose "Releases".


0.22.0 (2022-03-23)
Expand Down
16 changes: 8 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,7 @@ please let me know in any of the following ways:
Changelog
---------

See the :doc:`changelog` [#fn-changelog]_
for a history of notable changes to bidict.
For bidict release notes, see the :doc:`changelog` [#fn-changelog]_


Release Notifications
Expand All @@ -152,9 +151,9 @@ Release Notifications
.. duplicated in CHANGELOG.rst:
(would use `.. include::` but GitHub doesn't understand it)
`Watch <https://github.blog/changelog/2018-11-27-watch-releases/>`__ releases
`on GitHub <https://github.com/jab/bidict>`__
to be notified when new versions of bidict are released.
Watch `bidict releases on GitHub <https://github.com/jab/bidict/releases>`__
to be notified when new versions of bidict are published.
Click the "Watch" dropdown, choose "Custom", and then choose "Releases".


Learning from bidict
Expand All @@ -174,7 +173,7 @@ Contributing

I have been bidict's sole maintainer
and `active contributor <https://github.com/jab/bidict/graphs/contributors>`__
since I started the project almost 15 years ago.
since I started the project ~15 years ago.

Your help would be most welcome!
See the :doc:`contributors-guide` [#fn-contributing]_
Expand Down Expand Up @@ -215,8 +214,9 @@ in this manner:
- `<https://sethmlarson.dev/blog/people-in-your-software-supply-chain>`__
- `<https://engineering.atspotify.com/2022/04/announcing-the-spotify-foss-fund/>`__
- `<https://blog.sentry.io/2021/10/21/we-just-gave-154-999-dollars-and-89-cents-to-open-source-maintainers>`__
- `<https://www.cognitect.com/blog/supporting-open-source-developers>`__
- `<https://vorpus.org/blog/the-unreasonable-effectiveness-of-investment-in-open-source-infrastructure/>`__

.. - `<https://www.cognitect.com/blog/supporting-open-source-developers>`__
.. - `<https://vorpus.org/blog/the-unreasonable-effectiveness-of-investment-in-open-source-infrastructure/>`__
You can also support my work through
`Gumroad <https://gumroad.com/l/bidict>`__ or
Expand Down
6 changes: 3 additions & 3 deletions docs/learning-from-bidict.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ Learning from ``bidict``
Working on :mod:`bidict` has taken me to
some of the most interesting and unexpected places
I've ever gotten to visit in many years of programming.
(When I started this project almost 15 years ago,
(When I started this project ~15 years ago,
I'd never heard of things like higher-kinded types.
Thanks to :mod:`bidict`, I not only came across them,
I even got to `share an example with Guido
I even got to `share a practical, real-world example with Guido
<https://github.com/python/typing/issues/548#issuecomment-621195693>`__
of how they might be useful for bidirectional mapping types.)
where they would be beneficial for Python.)

The problem space that :mod:`bidict` inhabits
is abundant with beautiful symmetries,
Expand Down

0 comments on commit b394e88

Please sign in to comment.