Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gh-93610: Improve docs for importlib.resources #93611

Merged
merged 18 commits into from Jul 25, 2022
Merged

gh-93610: Improve docs for importlib.resources #93611

merged 18 commits into from Jul 25, 2022

Commits on Jun 8, 2022

  1. Add a concrete example of why you'd use importlib.resources over Path… 

    …(__file__)
    @encukou
    encukou committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    6a97526 View commit details
    Browse the repository at this point in the history

  2. Link to the definition of a new term

    @encukou
    encukou committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    77b50ae View commit details
    Browse the repository at this point in the history

  3. Add importlib.resources.abc docs to the hierarchy, to fix links

    @encukou
    encukou committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    89f00a2 View commit details
    Browse the repository at this point in the history

  4. Package: Document what this is first, then give the formal definition

    @encukou
    encukou committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    9134901 View commit details
    Browse the repository at this point in the history

  5. Shorten links to Traversable

    @encukou
    encukou committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    0274515 View commit details
    Browse the repository at this point in the history

  6. Link to Package

    @encukou
    encukou committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    39ab32a View commit details
    Browse the repository at this point in the history

  7. Move deprecated functions to a dedicated section, add modern equivalents

    @encukou
    encukou committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    521ad26 View commit details
    Browse the repository at this point in the history

  8. Move replacements to the ..deprecated sections

    @encukou
    encukou committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    719562b View commit details
    Browse the repository at this point in the history

  9. Remove the link to migrating legacy usage: this is now documented here.

    @encukou
    encukou committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    9bcca6b View commit details
    Browse the repository at this point in the history

  10. Remove errors arguments from the migration snippets

    @encukou
    encukou committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    ac007c3 View commit details
    Browse the repository at this point in the history

  11. Fix qualname of importlib.resources.abc.ResourceReader

    @encukou
    encukou committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    d1fefcb View commit details
    Browse the repository at this point in the history

  12. Reword the intro for deprecated functions

    @encukou
    encukou committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    993ea9e View commit details
    Browse the repository at this point in the history

  13. Remove unnecessary "headings"

    @encukou
    encukou committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    77acd33 View commit details
    Browse the repository at this point in the history

Commits on Jun 9, 2022

  1. Apply suggestions from code review 

    Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
    @encukou @AA-Turner @slateny
    3 people committed Jun 9, 2022
    Configuration menu
    Copy the full SHA
    1fb51a0 View commit details
    Browse the repository at this point in the history

Commits on Jun 16, 2022

  1. Move classes that are actually in importlib.abc out from importlib.re… 

    …sources.abc
    @encukou
    encukou committed Jun 16, 2022
    Configuration menu
    Copy the full SHA
    a5a5377 View commit details
    Browse the repository at this point in the history

  2. Fix references to classes in importlib.resources.abc

    @encukou
    encukou committed Jun 16, 2022
    Configuration menu
    Copy the full SHA
    a03df1f View commit details
    Browse the repository at this point in the history

Commits on Jul 25, 2022

  1. Merge remote-tracking branch 'upstream/main' into impres-docs

    @ambv
    ambv committed Jul 25, 2022
    Configuration menu
    Copy the full SHA
    85ad3c7 View commit details
    Browse the repository at this point in the history

  2. Slightly reword Package

    @ambv
    ambv committed Jul 25, 2022
    Configuration menu
    Copy the full SHA
    fa68025 View commit details
    Browse the repository at this point in the history