Skip to content

Commit 8476c46

Browse files
author
Release Manager
committed
gh-35460: Update developer guide for workflows on github
<!-- Please provide a concise, informative and self-explanatory title. --> <!-- Don't put issue numbers in the title. Put it in the Description below. --> <!-- For example, instead of "Fixes #12345", use "Add a new method to multiply two integers" --> ### 📚 Description Our developer guide needs to be updated incorporating the new workflows on GitHub. Here is the updated developer guide. I know this needs more editing, but at least it reached the point where other eyes would catch more errors, typos, and defects than mine alone. So please examine the built documentation and report errors, typos, and defects. If you think a major addition such as a new section is needed, then please open a new PR that builds on this PR and provide your own writing. <!-- Describe your changes here in detail. --> <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes #12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. It should be `[x]` not `[x ]`. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - #12345: short description why this is a dependency - #34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: #35460 Reported by: Kwankyu Lee Reviewer(s): Kwankyu Lee, Matthias Köppe, Sebastian Oehms, Tobias Diez
2 parents 4ed2157 + 4719a3f commit 8476c46

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+2017
-2727
lines changed

build/pkgs/configure/checksums.ini

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
tarball=configure-VERSION.tar.gz
2-
sha1=fa8e9c79b0857a18d0a7e6cb12e191d465e21e39
3-
md5=6b50e8ca9245b3b41d72335666036ce2
4-
cksum=2566457121
2+
sha1=896e4d369868e9f80990c64eb132b518cfba6688
3+
md5=03ea0f45da8434f4a46fe4499af53b64
4+
cksum=1394688091
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2d8444ddbd3ba506c88343ab73aa135f9ce2bf07
1+
31658166a79ad3024f5f122fe5faf8fb33122ed6

src/doc/en/a_tour_of_sage/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _a-tour-of-sage:
22

3-
==========================
4-
Welcome to a Tour of Sage!
5-
==========================
3+
=========================
4+
Welcome to a Tour of Sage
5+
=========================
66

77
This is a tour of Sage that closely follows the tour of Mathematica
88
that is at the beginning of the Mathematica Book.

src/doc/en/constructions/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
55
.. _constructions:
66

7-
Welcome to the Sage Constructions!
8-
==================================
7+
=============================
8+
Welcome to Sage Constructions
9+
=============================
910

1011
This document collects the answers to some questions along the line
1112
"How do I construct ... in Sage?" Though much of this material can

src/doc/en/developer/coding_basics.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ style conventions discussed in this chapter.
3131

3232
.. _section-coding-python:
3333

34-
Python Code Style
34+
Python code style
3535
=================
3636

3737
Follow the standard Python formatting rules when writing code for
@@ -90,7 +90,7 @@ In particular,
9090

9191
.. _chapter-directory-structure:
9292

93-
Files and Directory Structure
93+
Files and directory structure
9494
=============================
9595

9696
Roughly, the Sage directory tree is layout like this. Note that we use
@@ -193,7 +193,7 @@ search, but restricted to function definitions, while
193193
docstrings for more information and more options.
194194

195195

196-
Headings of Sage Library Code Files
196+
Headings of Sage library code files
197197
===================================
198198

199199
The top of each Sage code file should follow this format::
@@ -240,7 +240,7 @@ compatible, that is, less restrictive license (e.g. the BSD license).
240240

241241
.. _section-docstrings:
242242

243-
Documentation Strings
243+
Documentation strings
244244
=====================
245245

246246
.. _section-docstring-function:
@@ -473,7 +473,7 @@ information. You can use the existing functions of Sage as templates.
473473
Note the trailing underscores which makes the citations into hyperlinks. See
474474
below for more about the master bibliography file. For more about citations,
475475
see the `Sphinx/reST markup for citations
476-
<https://www.sphinx-doc.org/rest.html#citations>`_. For links to trac tickets
476+
<https://www.sphinx-doc.org/rest.html#citations>`_. For links to GitHub issues and PRs
477477
or wikipedia, see :ref:`chapter-sage_manuals_links`.
478478

479479
- A **TESTS** block (highly recommended).
@@ -771,7 +771,7 @@ there is not one already. That is, you can do the following:
771771
772772
.. _section-latex-typeset:
773773

774-
LaTeX Typesetting
774+
LaTeX typesetting
775775
-----------------
776776

777777
In Sage's documentation LaTeX code is allowed and is marked with **backticks**:
@@ -875,7 +875,7 @@ for details about how to add more macros.
875875

876876
.. _section-doctest-writing:
877877

878-
Writing Testable Examples
878+
Writing testable examples
879879
-------------------------
880880

881881
The examples from Sage's documentation have a double purpose:
@@ -983,7 +983,7 @@ written.
983983

984984
.. _section-further_conventions:
985985

986-
Special Markup to Influence Doctests
986+
Special markup to influence doctests
987987
------------------------------------
988988

989989
Overly complicated output in the example code can be shortened
@@ -1172,7 +1172,7 @@ framework. Here is a comprehensive list:
11721172

11731173
.. CODE-BLOCK:: rest
11741174
1175-
The following should yield 4. See :trac:`2`. ::
1175+
The following should yield 4. See :issue:`2`. ::
11761176
11771177
sage: 2+2 # optional - bug
11781178
5
@@ -1242,7 +1242,7 @@ further development on Sage.
12421242

12431243
.. _chapter-testing:
12441244

1245-
Running Automated Doctests
1245+
Running automated doctests
12461246
==========================
12471247

12481248
This section describes Sage's automated testing of test files of the
@@ -1257,7 +1257,7 @@ doctesting modules in the Sage library.
12571257

12581258
.. _section-testpython:
12591259

1260-
Testing .py, .pyx and .sage Files
1260+
Testing .py, .pyx and .sage files
12611261
---------------------------------
12621262

12631263
Run ``sage -t <filename.py>`` to test all code examples in
@@ -1282,7 +1282,7 @@ write for the documentation and have them work.
12821282
For more information, see :ref:`chapter-doctesting`.
12831283

12841284

1285-
Testing reST Documentation
1285+
Testing reST documentation
12861286
--------------------------
12871287

12881288
Run ``sage -t <filename.rst>`` to test the examples in verbatim
@@ -1325,7 +1325,7 @@ Sage.
13251325

13261326
.. _section-coding-general-whitespace:
13271327

1328-
General Coding Style Regarding Whitespace
1328+
General coding style regarding whitespace
13291329
=========================================
13301330

13311331
Use spaces instead of tabs for indentation. The only exception is for
@@ -1343,7 +1343,7 @@ If you use another editor, we recommend to configure it so you do not
13431343
add tabs to files. See :ref:`section-ide`.
13441344

13451345

1346-
Global Options
1346+
Global options
13471347
==============
13481348

13491349
Global options for classes can be defined in Sage using

src/doc/en/developer/coding_in_cython.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ up-to-date information or check out the
3232
to get started immediately.
3333

3434

35-
Writing Cython Code in Sage
35+
Writing cython code in Sage
3636
===========================
3737

3838
There are several ways to create and build Cython code in Sage.
@@ -69,7 +69,7 @@ There are several ways to create and build Cython code in Sage.
6969
Then run ``sage -b`` to rebuild Sage.
7070

7171

72-
Attaching or Loading .spyx Files
72+
Attaching or loading .spyx files
7373
================================
7474

7575
The easiest way to try out Cython without having to learn anything
@@ -142,7 +142,7 @@ version with a type declaration, by changing ``def is2pow(n):`` to
142142

143143
.. _section-interrupt:
144144

145-
Interrupt and Signal Handling
145+
Interrupt and signal handling
146146
=============================
147147

148148
When writing Cython code for Sage, special care must be taken to ensure
@@ -152,7 +152,7 @@ Sage uses the `cysignals package <https://github.com/sagemath/cysignals>`_
152152
for this, see the `cysignals documentation <http://cysignals.readthedocs.org/>`_
153153
for more information.
154154

155-
Unpickling Cython Code
155+
Unpickling Cython code
156156
======================
157157

158158
Pickling for Python classes and extension classes, such as Cython, is different.

src/doc/en/developer/coding_in_other.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ In this chapter, we discuss interfaces between Sage and :ref:`PARI
2020

2121
.. _section-pari-library:
2222

23-
The PARI C Library Interface
23+
The PARI C library interface
2424
============================
2525

2626
Here is a step-by-step guide to adding new PARI functions to Sage. We
@@ -570,7 +570,7 @@ One more example (in addition to the one in the docstring):
570570
((0, 1, 0), (1, 0, 0), (0, 0, 1))
571571

572572

573-
Singular: Another Approach
573+
Singular: another approach
574574
==========================
575575

576576
There is also a more Python-like interface to Singular. Using this,
@@ -626,7 +626,7 @@ implemented in the Sage/Singular interface, whereas the code in the
626626
previous section used only the barest minimum of that interface.
627627

628628

629-
Creating a New Pseudo-TTY Interface
629+
Creating a new pseudo-TTY interface
630630
===================================
631631

632632
You can create Sage pseudo-tty interfaces that allow Sage to work with
@@ -708,7 +708,7 @@ dumps the user into an Octave interactive shell:
708708
Use octave to compute a solution x to A*x = b, as a list.
709709
710710
INPUT:
711-
711+
712712
- A -- mxn matrix A with entries in QQ or RR
713713
- b -- m-vector b entries in QQ or RR (resp)
714714

src/doc/en/developer/coding_in_python.rst

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This chapter discusses some issues with, and advice for, coding in
88
Sage.
99

1010

11-
Python Language Standard
11+
Python language standard
1212
========================
1313

1414
Sage library code needs to be compatible with all versions of Python
@@ -45,7 +45,7 @@ using one of two mechanisms:
4545
The Sage library declares these packages as dependencies and ensures that
4646
versions that provide features of Python 3.11 are available.
4747

48-
Meta-ticket :trac:`29756` keeps track of newer Python features and serves
48+
Meta :issue:`29756` keeps track of newer Python features and serves
4949
as a starting point for discussions on how to make use of them in the
5050
Sage library.
5151

@@ -64,7 +64,7 @@ scratch. Try to figure out how your code should fit in with other Sage
6464
code, and design it accordingly.
6565

6666

67-
Special Sage Functions
67+
Special sage functions
6868
======================
6969

7070
Functions with leading and trailing double underscores ``__XXX__`` are
@@ -157,7 +157,7 @@ representing the object ``a``. Calling ``view(a)`` will display the
157157
typeset version of this.
158158

159159

160-
Print Representation
160+
Print representation
161161
--------------------
162162

163163
The standard Python printing method is ``__repr__(self)``. In Sage,
@@ -193,7 +193,7 @@ Here is an example of the ``_latex_`` and ``_repr_`` functions for the
193193
return "\\pi"
194194
195195
196-
Matrix or Vector from Object
196+
Matrix or vector from object
197197
----------------------------
198198

199199
Provide a ``_matrix_`` method for an object that can be coerced to a
@@ -232,7 +232,7 @@ will work for this object. The following is from the file
232232
233233
.. _section-preparsing:
234234

235-
Sage Preparsing
235+
Sage preparsing
236236
===============
237237

238238
To make Python even more usable interactively, there are a number of
@@ -307,7 +307,7 @@ In particular, the file ``preparse.py`` contains the Sage preparser
307307
code.
308308

309309

310-
The Sage Coercion Model
310+
The Sage coercion model
311311
=======================
312312

313313
The primary goal of coercion is to be able to transparently do
@@ -346,7 +346,7 @@ immutable later. See the file
346346
``SAGE_ROOT/src/sage/structure/mutability.py``.
347347

348348

349-
The __hash__ Special Method
349+
The __hash__ special method
350350
============================
351351

352352
Here is the definition of ``__hash__`` from the Python reference
@@ -474,7 +474,7 @@ Note that the syntax in ``except`` is to list all the exceptions that
474474
are caught as a tuple, followed by an error message.
475475

476476

477-
Integer Return Values
477+
Integer return values
478478
=====================
479479

480480
Many functions and methods in Sage return integer values.
@@ -585,8 +585,6 @@ by
585585
return initialize_big_data()
586586
587587
588-
589-
590588
Deprecation
591589
===========
592590

@@ -599,7 +597,7 @@ in the future. We call this a *deprecation*.
599597
Deprecated code can only be removed one year after the first
600598
stable release in which it appeared.
601599

602-
Each deprecation warning contains the number of the trac ticket that defines
600+
Each deprecation warning contains the number of the GitHub PR that defines
603601
it. We use 666 in the examples below. For each entry, consult the function's
604602
documentation for more information on its behaviour and optional arguments.
605603

@@ -672,7 +670,7 @@ documentation for more information on its behaviour and optional arguments.
672670
deprecation(666, "Do not use your computer to compute 1+1. Use your brain.")
673671
674672
675-
Experimental/Unstable Code
673+
Experimental/unstable code
676674
--------------------------
677675

678676
You can mark your newly created code (classes/functions/methods) as
@@ -720,7 +718,7 @@ reviewing process.
720718
experimental_warning(66666, 'This code is not foolproof.')
721719
722720
723-
Using Optional Packages
721+
Using optional packages
724722
=======================
725723

726724
If a function requires an optional package, that function should fail

src/doc/en/developer/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
html_static_path = [] + html_common_static_path
2222

2323
# General information about the project.
24-
project = "Developer's Guide"
24+
project = "Developer Guide"
2525

2626
# The name for this set of Sphinx documents.
2727
html_title = project
@@ -33,6 +33,6 @@
3333
# Grouping the document tree into LaTeX files. List of tuples
3434
# (source start file, target name, title, author, document class [howto/manual]).
3535
latex_documents = [
36-
('index', 'developer.tex', 'Developer\'s Guide',
36+
('index', 'developer.tex', 'Developer Guide',
3737
'The Sage Development Team', 'manual'),
3838
]

0 commit comments

Comments
 (0)