From b444ac2144f75d3fa5eafc63464b00a1f961cfb1 Mon Sep 17 00:00:00 2001 From: Akshat Sharma <147742601+Akshat1000Sharma@users.noreply.github.com> Date: Sun, 17 Nov 2024 19:49:56 +0530 Subject: [PATCH 1/2] Updated typo in contributing.rst --- docs/source/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index faf8ced..7735c8d 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -3,7 +3,7 @@ Contributing to AboutCode ######################### We welcome you and your interest in contributing to open source software! AboutCode -is always looking for enthusiatic contributors and we are happy to help with any questions +is always looking for enthusiastic contributors and we are happy to help with any questions or comments. Here a few resources to get started: 1) Take a look through our public repos here: https://github.com/aboutcode-org/ From a7b303ec7dfdd8f1203e3cf6b6bdb05d7f9ac570 Mon Sep 17 00:00:00 2001 From: Akshat Sharma <147742601+Akshat1000Sharma@users.noreply.github.com> Date: Sun, 17 Nov 2024 19:56:05 +0530 Subject: [PATCH 2/2] Fixed typos in contrib_doc.rst --- docs/source/contributing/contrib_doc.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/contributing/contrib_doc.rst b/docs/source/contributing/contrib_doc.rst index c3629aa..76981c5 100644 --- a/docs/source/contributing/contrib_doc.rst +++ b/docs/source/contributing/contrib_doc.rst @@ -81,7 +81,7 @@ Ensure that you have the latest files:: git pull git status -Before commiting changes run Continious Integration Scripts locally to run tests. Refer +Before committing changes run Continuous Integration Scripts locally to run tests. Refer :ref:`doc_ci` for instructions on the same. Follow standard git procedures to upload your new and modified files. The following commands are @@ -189,7 +189,7 @@ Intersphinx ScanCode toolkit documentation uses `Intersphinx `_ to link to other Sphinx Documentations, to maintain links to other Aboutcode Projects. -To link sections in the same documentation, standart reST labels are used. Refer +To link sections in the same documentation, standard reST labels are used. Refer `Cross-Referencing `_ for more information. For example:: @@ -203,7 +203,7 @@ For example:: It refers to the section itself, see :ref:`my-reference-label`. -Now, using Intersphinx, you can create these labels in one Sphinx Documentation and then referance +Now, using Intersphinx, you can create these labels in one Sphinx Documentation and then reference these labels from another Sphinx Documentation, hosted in different locations. You just have to add the following in the ``conf.py`` file for your Sphinx Documentation, where you @@ -242,7 +242,7 @@ For more information, refer this tutorial named .. _doc_style_conv: -Style Conventions for the Documentaion +Style Conventions for the Documentation -------------------------------------- 1. Headings