GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Restructure the devguide for Jython by jeff5 · Pull Request #1 · jython/devguide

Conversation

@jeff5

@jeff5 jeff5 commented Oct 4, 2017

Copy link
Copy Markdown
Member

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:

  • shot through with CPython specifics we must replace, and
  • likely to keep improving (which we'd like to merge).

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:

  • Where content applies to Jython, with simple edits, we keep the original file. The expectation is that subsequent merges will be automatic, or at leasst manageable manually.
  • Where extensive re-writing is needed we start a new "companion" file (e.g. buildbots_jy.rst) and we keep the original as a reference, and also as a target for merge operations we don't want to modify the Jython text.

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
jeff5 added 4 commits October 3, 2017 22:57
@jeff5
Restructure the devguide for Jython
8592497
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.
@jeff5
Rescue Frank Wierzbicki's text from the 2014 version
48880d8
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.
@jeff5
Ensure links are appropriate to Jython (index to section 3).
38e606b
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.
@jeff5
Ensure links are appropriate to Jython (:ref: and :doc:).
fb6988e
Check and fix hyperlinks (all the :ref: and :doc: formulae) so the
reader is not carried into material specific to CPython while
navigating.
@jeff5 jeff5 mentioned this pull request Oct 12, 2017
Delete the FAQ #2
Open
jeff5 added 3 commits October 15, 2017 14:06
@jeff5
Split coverage.rst into restored CPython and Jython versions.
572854e
Speak distinctly about Jython in a coherent section. Keep (and update)
the CPython story exactly as that project tells it.
@jeff5
Minor typos, clarity.
3d56927
@jeff5
Split runtests.rst into Jython-specific and CPython versions
96d8c27
Just too much divergence to remain common.
@jeff5

jeff5 commented Oct 20, 2017

Copy link
Copy Markdown
Member Author

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@jeff5
jeff5 merged commit b1451ec into jython:jython Oct 21, 2017
@jeff5
jeff5 deleted the jy_foundation branch October 22, 2017 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

1 participant

@jeff5
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.