In preparation for the 1.0.0** release of the TUF reference
implementation `python-tuf` documentation referenced in this PEP is
being moved. This patch updates the corresponding links in the PEP.
** See 059bfda391/docs/1.0.0-ANNOUNCEMENT.md
More specifically, the following link changes are performed:
- METADATA.md
to: metadata format section in TUF spec
Note: alternatively this could link to the new location of
METADATA.md (see theupdateframework/python-tuf#1769), but the spec
seems like a better resource
- TUTORIAL.md#repo-management
to: new metadata API doc on readthedocs and new repo
example/tutorial
- TUTORIAL.md#lazy-bin-walk
to: new hashed bin delegation example/tutorial
- client implementation
to: new client doc on readthedocs
Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
We're getting ready for a final request for comments to python-dev,
so I did one more pass through the PEP to catch remaining readability
issues (I was especially looking for things easier to see on the actual
PEP page with formatting than the rst doc):
- found an incorrectly formatted hyperlink
- changed some sentences with ambiguous pronouns
- broke up a couple of sentences that seemed too long
- tweaked a few places where the wording was okay but nonstandard
* Add more rejected alternatives
- Rust-style syntax
- Forced outer parentheses
- Improving readability of existing callable type
* Add discussion of alternative | precedence
* Add blank lines for bullet lists
* Fixes based on initial review
* More tweaks from review
* More updates based on review
* fast locals proxy never assumes the value cache is already up to date
* operations become O(n) as required to avoid that assumption
* remove `*View()` APIs from proposal due to algorithmic complexity issue
* add Python pseudo-code to the PEP 667 comparison section
* reword PEP 667 comparison section to focus on the remaining differences
in the C API proposal
* PEP 639: Reframe core metadata update as discrete proposal per PEP 643
* PEP 639: Clean up formatting, syntax, spelling, headers and lists
* PEP 639: Rewrite to reflect License-Expression field and depr process
* PEP 639: Update examples, current tools survey, links and more
* PEP 639: Add PEP 621, expand/move examples & reorganize/shorten headings
* PEP 639: Further specify and clarify license file handling
* PEP 639: Add additional ambigous classifiers and tool recommendations
* PEP 639: Rework PEP 621 keys, refine dynamic/globs & add rejected ideas
* PEP 639: Specify license path root & subdirs, & expand examples
* PEP 639: Add license_files dir, rejected ideas & sdist/wheel/installed
* PEP 639: Add PyPI validation of new fields for newly-uploaded files
* PEP 639: Add open isssue for back-filling & reject per-dist licenses
* PEP 639: Add User Scenarios to provide guidance for common use cases
* PEP 639: Update Abstract, Goals, Rationale, Compat. & other sections
* PEP 639: Add terminology section & use consistant, clear & correct terms
* PEP 639: Make refs inline per #2130, add links, fix others & refine text
* PEP 639: Copyedit and proofread for grammar, phrasing, clarity & tone
* PEP 639: Address reviewer and community feedback
* PEP 639: Add custom IDs issue & clarify rejected license key str value
Thanks to Eric Traut who tested all the code examples in Pyright and
raised implementation concerns about ``Self`` type in aliases.
I ran into implementation issues in Pyre too. This is because Pyre
preprocesses things like ``Self`` in an early phase and does alias
resolution in a later phase. Mixing the two would lead to a lot of
hacks.
* Address Guido's comments from initial PR
* Update functions-as-types based on Pradeep's feedback
* Fix some markup, address comments on endpoint example
* Rearrange Motivation and Rationale
* Move the language comparison subsection to Rational
* Fix more markup errors
* Rework "Motivation" section again
Going with Pradeep's suggested order:
- untyped example
- correct types
- partially-typed code
- our proposal
* Fix more lint errors
* Add a section highlighting a concern about -> readability
* Update the add/wrap/flatmap example
* Wording change suggested by AlexWaygood
* Add missing return annotation
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* Break up long sentence
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* Break up long sentence (thanks Jelle)
* Reword awkward sentence (thanks Pradeep)
* Rearrange paragraphs in Motivation
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>