1- .. This file has been modified from the CPython version.
2- Modifications are extensive, and normally this would mean we should write a
3- new file index_jy.rst, but the expectation is that index.rst is the starting
4- point for the documentation.
5- We therefore keep it as modified, although merging from the CPython devguide
6- is more difficult this way.
1+ .. This file has been extensively modified from the CPython version.
2+ Normally this would mean a new file index_jy.rst, but index.rst is the
3+ starting point for the documentation.
4+ We therefore keep it as modified, although merging changes from the CPython
5+ devguide difficult for this file.
76
87========================
98Jython Developer's Guide
@@ -16,14 +15,13 @@ bear in mind that:
1615
1716* The CPython process is PR-based on GitHub and this guide anticipates our
1817 adoption of that for Jython.
19- * The existing Jython process uses Mercurial hosted at ``python.org ``, and
20- patches via the bug-tracker: you will find that in this guide too.
21- * When the guide says "Python", that section is true for Jython too.
18+ * The existing Jython process uses Mercurial so the guide describes that too.
19+ * Statements about "Python" should apply to both CPython and Jython.
2220* The adaptation is imperfect: parts of the guide will say (or mean) CPython.
2321
2422This guide is :ref: `maintained <helping-with-the-developers-guide >` by the same
2523community that maintains CPython and Jython.
26- We welcome your contributions to both these implementations of Python!
24+ We welcome your contributions to either implementation of Python!
2725
2826
2927Quick Reference
@@ -32,11 +30,11 @@ Quick Reference
3230Mercurial
3331^^^^^^^^^
3432
35- 1. :ref: `Get the source code <checkout >`::
33+ 1. :ref: `Get the source code <checkout-jy >`::
3634
3735 hg clone http://hg.python.org/jython
3836
39- 2. :ref: `Build Jython <compiling >`::
37+ 2. :ref: `Build Jython <compiling-jy >`::
4038
4139 ant
4240
@@ -178,11 +176,12 @@ Contributing
178176------------
179177
180178We encourage everyone to contribute to Python and that's why we have put up this
181- We encourage everyone to contribute to Jython and that's why we have put up this
182179developer's guide. If you still have questions after reviewing the material in
183180this guide, then the `Python Mentors `_ group is available to help guide new
184181contributors through the process.
185182
183+ .. FIXME: do Python Mentors help Jython contributors with process?
184+
186185 A number of individuals from the Python community have contributed to a series
187186of excellent guides at `Open Source Guides <https://opensource.guide/ >`_.
188187
@@ -193,17 +192,17 @@ Core developers and contributors alike will find the following guides useful:
193192
194193Guide for contributing to Jython:
195194
196- * :doc: `setup `
195+ * :doc: `setup_jy `
197196* :doc: `help `
198- * :doc: `pullrequest `
199- * :doc: `patch_hg_jy `
197+ * :doc: `patch_hg_jy ` (existing process)
198+ * :doc: `pullrequest ` (partly usable future process)
200199* :doc: `runtests `
201200* Beginner tasks to become familiar with the development process
202201 * :doc: `docquality `
203202 * :doc: `coverage `
204203* Advanced tasks for once you are comfortable
205204 * :doc: `silencewarnings `
206- * Fixing issues found by the :doc: `buildbots <buildbots >`
205+ * Fixing issues found by the :doc: `buildbots <buildbots_jy >`
207206 * :doc: `fixingissues `
208207* :ref: `tracker ` and :ref: `helptriage `
209208 * :doc: `triaging `
@@ -213,8 +212,7 @@ Guide for contributing to Jython:
213212 * :doc: `committing `
214213 * :doc: `committing_hg_jy `
215214 * :doc: `devcycle `
216- * :doc: `buildbots `
217- * :doc: `coverity `
215+ * :doc: `buildbots_jy `
218216* :doc: `gitbootcamp `
219217
220218It is **recommended ** that the above documents be read in the order listed. You
@@ -245,8 +243,8 @@ happen and that process is also described as part of this guide:
245243Other Interpreter Implementations
246244---------------------------------
247245
248- This guide is specifically for contributing to Python on the JVM ,
249- also known as Jython . (While most of the standard library is written in Python,
246+ This guide is specifically for contributing to Jython, that is ,
247+ Python on the JVM . (While most of the standard library is written in Python,
250248the interpreter core is written in Java and integrates most easily with the Java
251249SE and EE ecosystems).
252250
@@ -276,8 +274,8 @@ Key Resources
276274 tracker for the issue tracker)
277275 * :doc: `experts `
278276* Source code
279- * `Browse online <http://hg.python.org/jython/file/default/ >`_
280- <https://github.com/jython/jython/>`_
277+ * `Browse in Mercurial online <http://hg.python.org/jython/file/default/ >`_
278+ * ` Browse in GitHub <https://github.com/jython/jython/ >`_
281279
282280* PEPs _ (Python Enhancement Proposals)
283281* :doc: `help `
@@ -294,7 +292,6 @@ Additional Resources
294292 * :doc: `grammar_jy `
295293 * :doc: `compiler_jy `
296294* Tool support
297- * Various tools with configuration files as found in the `Misc directory `_
298295 * Information about editors and their configurations can be found in the
299296 `wiki <https://wiki.python.org/moin/PythonEditors >`_
300297
@@ -350,8 +347,8 @@ Specific to CPython_
350347--------------------
351348
352349These are sections from the CPython guide, retained for reference.
353- A comparison with the CPython implementation of a feature can help you
354- understand the Jython one.
350+ A comparison with the CPython implementation of a feature will sometimes help
351+ you understand the Jython one.
355352
356353.. We're also keeping these files for the technical reason that changes from
357354 CPython upstream can only be merged if these CPython files continue to exist.
0 commit comments