Skip to content

Commit

Permalink
Added the link to documentation for a better experience (#409)
Browse files Browse the repository at this point in the history
* Added a link to the documentation, as code snippets are not being rendered properly

* Added Changelog

* Changed the branch name from master to main

* changes added to changelog

* Simplified the documentation LINK

---------

Co-authored-by: Kushal Gajurel <kushal.gajurel@renegadeinsurance.com>
  • Loading branch information
Mgajurel and Kushal Gajurel committed Jul 12, 2023
1 parent 4333249 commit aa6f8f0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Tenacity
:target: https://mergify.io
:alt: Mergify Status

**Please refer to the** `tenacity documentation <https://tenacity.readthedocs.io/en/latest/>`_ **for a better experience.**

Tenacity is an Apache 2.0 licensed general-purpose retrying library, written in
Python, to simplify the task of adding retry behavior to just about anything.
It originates from `a fork of retrying
Expand Down Expand Up @@ -622,7 +624,7 @@ Contribute
#. Check for open issues or open a fresh issue to start a discussion around a
feature idea or a bug.
#. Fork `the repository`_ on GitHub to start making your changes to the
**master** branch (or branch off of it).
**main** branch (or branch off of it).
#. Write a test which shows that the bug was fixed or that the feature works as
expected.
#. Add a `changelog <#Changelogs>`_
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
other:
- |
Added a link to the documentation, as code snippets are not being rendered properly
Changed branch name to main in index.rst

0 comments on commit aa6f8f0

Please sign in to comment.