From aa6f8f0a2428de696b237d1a86bc131c1cdb707a Mon Sep 17 00:00:00 2001 From: Kushal Gajurel Date: Wed, 12 Jul 2023 14:59:31 +0545 Subject: [PATCH] Added the link to documentation for a better experience (#409) * 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 --- doc/source/index.rst | 4 +++- .../added_a_link_to_documentation-eefaf8f074b539f8.yaml | 5 +++++ 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml diff --git a/doc/source/index.rst b/doc/source/index.rst index f012f464..ce586f9e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -10,6 +10,8 @@ Tenacity :target: https://mergify.io :alt: Mergify Status +**Please refer to the** `tenacity documentation `_ **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 @@ -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>`_ diff --git a/releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml b/releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml new file mode 100644 index 00000000..381ddc4a --- /dev/null +++ b/releasenotes/notes/added_a_link_to_documentation-eefaf8f074b539f8.yaml @@ -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