From ec0d5c1f67ac488421c8a5662e4f8df5d7720fa0 Mon Sep 17 00:00:00 2001 From: Maxime Rey Date: Thu, 17 Mar 2022 15:09:24 +0100 Subject: [PATCH 1/2] Correct the link toward Google style guide. --- doc/source/guidelines/doc_practices.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/source/guidelines/doc_practices.rst b/doc/source/guidelines/doc_practices.rst index 3f89e9e25..c44f115df 100644 --- a/doc/source/guidelines/doc_practices.rst +++ b/doc/source/guidelines/doc_practices.rst @@ -4,7 +4,7 @@ Documentation Practices ======================= PyAnsys documentation must not only be written but also maintained. If you are new to writing developer documentation, see the `Google Developer Documentation -Style Guide `_. It provides +Style Guide `_. It provides editorial guidelines for writing clear and consistent developer documentation, allowing this guide to supply guidance specific to PyAnsys library documentation. @@ -186,7 +186,7 @@ Cloning a GitHub Repository --------------------------- Contributing to a GitHub repository requires that you first clone the repository. While developers likely know many ways to do this, technical documentation specialists may need to review the -following instructions for using either Windows PowerShell or GitBash to clone a GitHub repository. +following instructions for using either Windows PowerShell or Git Bash to clone a GitHub repository. Using Windows PowerShell to Clone a GitHub Repository ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -218,12 +218,12 @@ To use Windows PowerShell to clone a GitHub repository: .. note:: In PowerShell, typing ``dir`` is the equivalent to typing ``ls``. -Using GitBash to Clone a GitHub Repository +Using Git Bash to Clone a GitHub Repository ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -To use GitBash to clone a GitHub repository: +To use Git Bash to clone a GitHub repository: #. In the directory where you want to clone PyAnsys repositories, right-click and - select ``GitBash Here``. + select ``Git Bash Here``. #. Type ``git clone`` followed by the address of the repo to clone. @@ -347,7 +347,7 @@ the GitHub PR: If your PR is ready for review, select ``Create pull request``. Otherwise, select ``Create draft pull request`` and mark it as ready for review once - you it includes all of your changes and you are satisfied with it. + it includes all of your changes and you are satisfied with it. If you need to change a PR title, to its right, click the ``Edit`` button, which becomes a ``Save`` button while you are in editing mode. From 6270c7b550e1294a6f751d4c8296483a32ba4a6e Mon Sep 17 00:00:00 2001 From: Maxime Rey Date: Thu, 17 Mar 2022 17:55:00 +0100 Subject: [PATCH 2/2] Fix the underline length. --- doc/source/guidelines/doc_practices.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/guidelines/doc_practices.rst b/doc/source/guidelines/doc_practices.rst index c44f115df..632d5b48d 100644 --- a/doc/source/guidelines/doc_practices.rst +++ b/doc/source/guidelines/doc_practices.rst @@ -219,7 +219,7 @@ To use Windows PowerShell to clone a GitHub repository: In PowerShell, typing ``dir`` is the equivalent to typing ``ls``. Using Git Bash to Clone a GitHub Repository -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To use Git Bash to clone a GitHub repository: #. In the directory where you want to clone PyAnsys repositories, right-click and