Restructure the devguide for Jython #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Two strategies have been applied, depending on how CPython specific was the original file. Where content applies to Jython, with simple edits, we keep the original file. Where extensive re-writing is needed we start a new "companion" file (e.g. grammar_jy.rst) and keep the original for reference. The aim is to allow changes to be merged as the CPython devguide develops. index.rst is an exception as it is the conventional start page and cannot be renamed even though change is extensive.
These are words specific to Jython and Mercurial, merged by hand. We restore some sections the CPython version has lost or never had. Much is still in place that is CPython-specific.
Check and fix hyperlinks so the reader is not carried into material specific to CPython while navigating. Also fix up content at the destination sections, where reasonably easy to do.
Check and fix hyperlinks (all the :ref: and :doc: formulae) so the reader is not carried into material specific to CPython while navigating.
Open
Speak distinctly about Jython in a coherent section. Keep (and update) the CPython story exactly as that project tells it.
Just too much divergence to remain common.
|
Well, it's not free of CPython specific text by any means, but I believe I've rescued all the text from @fwierzbicki's work and structured the guide suitably for our needs. Also, I want to see if I'm right that we are able to merge changes made to the CPython devguide, and what the process is ... which should be documented in the guide, of course. :) I'll call PR done for now and merge soon. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Not recommended for merging until free of CPython specifics.
We'd like a Jython devguide based on CPython's, but the problem is that the CPython one is:
Here I've tried to guess which files only need minor change. Two strategies have been applied, depending on how CPython specific was the original file:
The aim is to allow changes to be merged as the CPython devguide develops.
index.rst is an exception as it is the conventional start page and cannot be renamed even though change is extensive.