Skip to content

Commit 9669abc

Browse files
committed
Minor edits
1 parent 4e902b1 commit 9669abc

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

src/doc/en/developer/github.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -488,8 +488,7 @@ Documentation Previews
488488
We value documentation as much as the code. Hence the Sage GitHub repo provides
489489
documentation previews before a stable release is published to the official
490490
site `<https://doc.sagemath.org>`_. Developers are expected to check the
491-
previews during the development process. Several GitHub workflows work together
492-
to create the previews.
491+
previews. Several GitHub workflows work together to create the previews.
493492

494493
As mentioned above, for a check on a PR (say #12345), an HTML documentation
495494
preview is published to `<https://doc-pr-12345--sagemath.netlify.app>`_ by the
@@ -514,7 +513,7 @@ requesting review. If the workflow failed, check the run of the workflow.
514513

515514
The HTML documentation preview for a PR does not include PDF docs, which take
516515
much longer time to build than the HTML docs. On the other hand, the
517-
documentation preview (either HTML and PDF) contains TESTS blocks to enable the
516+
HTML documentation preview and PDF docs contain TESTS blocks to enable the
518517
PR author to check newly added TESTS blocks. The official documentation for end
519518
users do not contain TESTS blocks.
520519

@@ -525,7 +524,7 @@ in the `Documentation section of the GitHub Wiki
525524
<https://github.com/sagemath/sage/wiki#documentation-for-last-release>`_. The
526525
`run of the PDF build workflow
527526
<https://github.com/sagemath/sage/actions/workflows/doc-build-pdf.yml>`_
528-
contains the artifact ``livedoc`` used to publish the full documentation.
527+
contains the ``livedoc`` artifact used to publish the full documentation.
529528

530529
Final notes
531530
===========

0 commit comments

Comments
 (0)