This repository has been archived by the owner on May 31, 2020. It is now read-only.
How-To Update for Docs (building on #816) #826
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
… section. Added a tour of the code. Fixed a grammar error.
Conflicts: docs/how-to/contribute-docs.rst docs/how-to/index.rst Decided to resolve the `docs/how-to/index.rst` conflict as not including the titles (i.e. follow the Don't Repeat Yourself or DRY principle). A rendered example can be seen at: https://batavia.readthedocs.io/en/latest/how-to/ This builds on #816 though as noted there it leaves the docs somewhat repetitive and so more completely merging with #823 seems appropriate.
I can see the pythonanywhere.com is at 3.7.0, though CPython is considered somewhat more authoritative. If repl.it (at 3.7.4) allows embedding in future, that may become a better candidate for python.org, though many people still prefer the lower latency of a local machine terminal shell-like experience which the shell version suggests (perhaps even encourages with the higher latency to wait for it to load). Anyway I'm sure someone else is aware of far more detail than I can see here.
They are the star on which this guide is constructed.
From general experience, a lot of developers and engineers I've worked with acknowledge the ECMA specifications, though actually consult the MDN resource when they just want a quick overview of something as it's often simply easier than explaining the long history of the language, which is the goal here - get someone started off, without too much detail.
Please forgive my occasional OCD.
I think list() as a collection type in types/List.js (and a 700+ line implementation) would be better in an advanced guide.
Resolves an error in "make html": /Users/pzrq/Projects/beeware/batavia/docs/how-to/tour.rst:75:Could not lex literal_block as "javascript". Highlighting skipped.
|
Aside: I see a warning when running |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR builds on #819, specifically it:
builtinsguidebuiltinsguide fromlist()(which I think is a more advanced-level guide, and also covered better in types) to a more intermediate-level guide with themax()function. I'm not wedded tomax(), its errors just seemed a little more interesting thanabs()Many of the changes above were suggested as feedback on #816, so I have done what I can to move this forward.
PR Checklist: