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

Autogenerated documentation mis-represents "mode" argument defaults #197

Closed
SethMMorton opened this issue Oct 1, 2020 · 3 comments
Closed

Autogenerated documentation mis-represents "mode" argument defaults #197

SethMMorton opened this issue Oct 1, 2020 · 3 comments
Labels
enhancement help wanted

Comments

@SethMMorton
Copy link
Contributor

SethMMorton commented Oct 1, 2020 •
edited
Loading

In the code, the mode default is 0o777. This is the number 511 in decimal. Here is what the mode default shows in the documentation:

image

It just so happens that 511 (in octal) would be a valid (but odd) mode.

Since the displayed default does not have the 0o prefix, a user unfamiliar with the requirement that the mode be given with the octal prefix to match what they would supply to the chmod tool might get confused and give (for example) makedir(mode=750) which would not do what they expect. (Source: I had a colleague do exactly that based on the representation of the default mode in the documentation).

I realize this might be more effort than it is worth, but if there was a way to force the documentation to render this in octal it might be clearer, like the Python docs to here:

image
@jaraco
Copy link
Owner

jaraco commented Dec 8, 2020

I agree that would be preferable, though I don't know any way to configure automodule to present default values as octal. My guess is it would require a feature request to the relevant project, as I don't see anything about honoring octal literals. I'd be disinclined to accept a change that requires a second copy of the rendered docs.

@jaraco jaraco mentioned this issue Dec 31, 2020
Closed
@jaraco
Copy link
Owner

jaraco commented Jul 25, 2021

Looks like Sphinx has a plugin that might enable this behavior (sphinx-doc/sphinx#8771). Would someone be willing to try that out?

jaraco added a commit that referenced this issue Sep 25, 2022
@jaraco
Add sphinx.ext.autodoc.preserve_defaults. Ref #197.
2d705de
@jaraco
Copy link
Owner

jaraco commented Sep 25, 2022 •
edited
Loading

I tried adding the extension to the build, but the oct defaults still render as decimal.

jaraco added a commit to jaraco/skeleton that referenced this issue Sep 25, 2022
@jaraco
When rendering docs, preserve the syntax for defaults. Fixes jaraco/p…
92fd50c 
…ath#197.

Incidentally, re-organize the extensions a bit for clarity.
jaraco added a commit to jaraco/skeleton that referenced this issue Sep 25, 2022
@jaraco
When rendering docs, preserve the syntax for defaults. Fixes jaraco/p…
b4f0ae6 
…ath#197.

Incidentally, re-organize the extensions a bit for clarity.
clrpackages pushed a commit to clearlinux-pkgs/pypi-jaraco.classes that referenced this issue Sep 29, 2022
@fenrus75
pypi-jaraco.classes: Autospec creation for update from version 3.2.2 …
4b1c570 
…to version 3.2.3

Jason R. Coombs (10):
      Use '-dev' for every Python version. Ref actions/setup-python#213.
      Use Python 3.11 for cutting releases.
      Pin flake8. Workaround for tholo/pytest-flake8#87.
      Rename _ensure_method for better clarity. Use tristate expression.
      Update to setup-python v4. Fixes jaraco/skeleton#65.
      Also update release to v4
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Add badge and link for documentation. Fixes #7.
      Update changelog.
clrpackages pushed a commit to clearlinux-pkgs/pypi-jaraco.functools that referenced this issue Sep 29, 2022
@fenrus75
pypi-jaraco.functools: Autospec creation for update from version 3.5.…
97c16f2 
…1 to version 3.5.2

Jason R. Coombs (9):
      Use '-dev' for every Python version. Ref actions/setup-python#213.
      Use Python 3.11 for cutting releases.
      Pin flake8. Workaround for tholo/pytest-flake8#87.
      Update to setup-python v4. Fixes jaraco/skeleton#65.
      Also update release to v4
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Also xfail on Windows runs, as they seem now to be exhibiting the same behavior as the mac runs.
      Update changelog.
clrpackages pushed a commit to clearlinux-pkgs/pypi-setuptools that referenced this issue Sep 30, 2022
@fenrus75
pypi-setuptools: Autospec creation for update from version 65.4.0 to …
93bc4ee 
…version 65.4.1

Jason R. Coombs (33):
      Use path.Path for changing the cwd temporarily.
      Remove needless assert renderings. Any decent test runner will provide this detail.
      Remove reference to duplicate issue.
      Refactor _is_python_source_dir using pathlib.
      Use 'samefile' to check for same file, because they may not be the same path. Fixes #180.
      Split test into two tests.
      Use pathlib
      Remove special case for TestCore.write_setup.
      Replace TESTFN with temp_file fixture.
      Remove 'cleanup_testfn', unused.
      Remove distracting comments
      In test_sysconfig, prefer fixtures to TESTFN.
      Remove cleanup_testfn, no longer used.
      Replace TESTFN with fixture.
      Remove empty logic branch.
      Use path.Path for changing the cwd temporarily.
      Remove reliance on TESTFN in test_dist
      Remove TESTFN from py38compat, no longer needed.
      xfail srcdir_simple on Windows
      Remove reliance on os_helper in test_build_ext
      Remove reliance on change_cwd
      Add compatibility shim for subprocess on Python 3.7 on Windows
      Extract _save_cwd for saving the current working directory.
      Prefer a temp_cwd fixture to reduce indentation.
      Remove reliance on create_empty_file
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Add test for PermissionError. Ref pypa/distutils#181.
      Use os.path.isfile for checking if path.is_file, suppresses exceptions. Fixes pypa/distutils#181.
      Update changelog
      Use pathlib to open the file
      Update changelog
      Bump version: 65.4.0 → 65.4.1

Julien Palard (1):
      expand: Give bytes to ast.parse to let it discover encoding cookie.

Matthias Koeppe (3):
      .github/workflows/ci-sage.yml: Use reusable workflow https://github.com/sagemath/sage/blob/develop/.github/workflows/docker.yml
      .github/workflows/ci-sage.yml: Run on pull_request when the yml file is modified
      .github/workflows/ci-sage.yml: Use reusable workflow from https://trac.sagemath.org/ticket/33288
clrpackages pushed a commit to clearlinux-pkgs/pypi-importlib_metadata that referenced this issue Oct 3, 2022
@fenrus75
pypi-importlib_metadata: Autospec creation for update from version 4.…
436dc93 
…12.0 to version 5.0.0

Anderson Bravalheri (13):
      Capture expectations about _normalized_name compatibility in test
      Add compatibility layer for Python 3.8 stdlib lack of _normalized_name
      Add compatibility for EntryPoint.matches in stdlib 3.8/3.9
      Add type annotations to EntryPoint.name/value/group
      Make sure Python 3.8/3.9 compatibility tests run on CI
      Workaround missing distribution name
      Fix typecheck error by simplifying compatibility shim
      Add "short circuit" optimization
      Extract tests for Python 3.9 compatibility into their own file
      Extract Python 3.9 compatibility layer into its own file
      Add comments clarifying implementation choices
      Fix imports
      Skip coverage in type checking statement

C.A.M. Gerlach (6):
      Add intersphinx support for packaging.python.org
      Clarify import vs distribution package terms in using.rst
      Link distribution/import package terms to PyPA glossary on 1st use
      Add admonition further clarifying import vs distribution packages
      Link to canonical core metadata spec instead of an old historical PEP
      Mention API ref & migration guide in importlib_metadata See Also

Jason R. Coombs (35):
      Add Tidelift template
      Rely on alabaster theme to support sidebar rendering.
      Use nicer, simpler phrasing
      Add support for automatic publishing of release notes
      Use technique for environment passing matching that found in jaraco/skeleton
      Move Tidelift token into Travis configuration
      Update badge URL
      Add funding reference to project
      List sidebars to avoid errors looking for template 't'
      Rebrand to 'For Enterprise'
      Add a 'For Enterprise' section to the README
      Include token passthrough for azure pipelines publish stage.
      Move Tidelift release note publishing to Github Actions.
      Tidelift no longer requires or expects publishing release notes.
      Remove Tidelift from main.yml, no longer needed
      Implement tidelift banner using a Sphinx directive implemented by jaraco.tidelift.
      Consolidate more language between the backport and the canonical usage docs.
      Ran pre-commit autoupdate
      Use '-dev' for every Python version. Ref actions/setup-python#213.
      Use Python 3.11 for cutting releases.
      Pin flake8. Workaround for tholo/pytest-flake8#87.
      Update to setup-python v4. Fixes jaraco/skeleton#65.
      Also update release to v4
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Adopt furo theme for docs.
      Update changelog
      Expand possibilities for "top-level names".
      Remove SelectableGroups
      Remove DeprecatedList
      Remove compatibility for EntryPoints.__getitem__ by index.
      Remove support for cast of iterable of entry points to dict. Ref #97.
      Update changelog
      Disable flake8 due to incompatibility.
      Update documentation around removal of SelectableGroups.

Oleg Iarygin (1):
      gh-93851: Fix all broken links in Doc/ (GH-93853)

Ville Skyttä (1):
      bpo-22295: use python -m pip rather than plain pip in more examples (GH-24003)
clrpackages pushed a commit to clearlinux-pkgs/pypi-backports.entry_points_selectable that referenced this issue Oct 3, 2022
@fenrus75
pypi-backports.entry_points_selectable: Autospec creation for update …
2c6e07f 
…from version 1.1.1 to version 1.2.0

Anderson Bravalheri (2):
      Ignore flake8/black warnings with pytest 7.0.1 (jaraco/skeleton#58)
      Update Github actions to v3 (#62)

Hugo van Kemenade (1):
      Update base URL for PEPs (#61)

Jason R. Coombs (24):
      Require Python 3.7 or later.
      Ignore nitpicks in private classes of importlib_metadata. I tried creating the intersphinx mapping, but since those classes aren't in importlib_metadata.__all__, they don't show up in the docs so can't be linked. Fixes #6.
      Remove filtered warnings, addressed upstream.
      Update badge year
      Remove setup.py, no longer needed.
      Add exclusions for pytest 7 deprecations in plugins. Fixes jaraco/skeleton#57.
      Use the parent category PytestDeprecationWarning, which is available on older pytest versions. Fixes jaraco/skeleton#57.
      Bump pytest-mypy and remove workaround for realpython/pytest-mypy#131.
      Require jaraco.packaging 9 adding compatibility for projects with no setup.py file.
      Ran pre-commit autoupdate
      Add Python 3.11 into the matrix using workaround from actions/setup-python#213. Drop 3.9 from matrix for efficiency.
      Prefer spaces for rst. Fixes jaraco/skeleton#64.
      Honor PEP 518 with pytest-enabler.
      Ran pre-commit autoupdate
      Use '-dev' for every Python version. Ref actions/setup-python#213.
      Use Python 3.11 for cutting releases.
      Pin flake8. Workaround for tholo/pytest-flake8#87.
      Update to setup-python v4. Fixes jaraco/skeleton#65.
      Also update release to v4
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Adopt furo theme for docs.
      Drop support for testing on Python 2.7, 3.6.
      Require Python 3.7 or later

Sviatoslav Sydorenko (1):
      Inject check job into CI workflow as ultimate flag (#55)

wim glenn (1):
      exclude build env from cov reporting (#60)
@jaraco jaraco mentioned this issue Oct 6, 2022
Closed
clrpackages pushed a commit to clearlinux-pkgs/pypi-importlib_resources that referenced this issue Oct 11, 2022
@fenrus75
pypi-importlib_resources: Autospec creation for update from version 5…
fef8ffa 
….9.0 to version 5.10.0

Jason R. Coombs (27):
      Inline type defintions
      Implement resolve as a single-dispatch function. (#261)
      Use '-dev' for every Python version. Ref actions/setup-python#213.
      Use Python 3.11 for cutting releases.
      Pin flake8. Workaround for tholo/pytest-flake8#87.
      Update to setup-python v4. Fixes jaraco/skeleton#65.
      Also update release to v4
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Adopt furo theme for docs.
      Indicate to use latest Python version (workaround for readthedocs/readthedocs.org/#9623). Requires also specifying the OS version (workaround for readthedocs/readthedocs.org#9635).
      Add test capturing current behavior and missed expectation. Ref #203.
      Remove restriction that a 'package' cannot be a module. Allows resolution of resources from adjacent modules, even those not found in a package. Fixes #203.
      Update changelog. Ref #203.
      Update docs to prefer the name 'anchor' to 'package', as the anchor may be a module.
      Rewrite section using imperative voice and add determiners.
      Remove docs pertinent to Python 3.6 and earlier.
      Extend type spec for clarity.
      Use more namespaces.
      Prefer relative imports for abc.
      Correct the changelog to mention the correct function affected.
      Rename the 'package' parameter to 'anchor'.
      Add doctests to flesh out coverage.
      Add test capturing expectation.
      Extract fixture for SiteDir.
      Implement caller inference to allow ``files()`` to be called without any parameter.
      Update changelog

sobolevn (1):
      Replace `abstractproperty` with `property` + `abstractmethod`
clrpackages pushed a commit to clearlinux-pkgs/pypi-zipp that referenced this issue Oct 11, 2022
@fenrus75
pypi-zipp: Autospec creation for update from version 3.8.1 to version…
832c4d6 
… 3.9.0

Jason R. Coombs (19):
      Use '-dev' for every Python version. Ref actions/setup-python#213.
      Use Python 3.11 for cutting releases.
      Pin flake8. Workaround for tholo/pytest-flake8#87.
      Update to setup-python v4. Fixes jaraco/skeleton#65.
      Also update release to v4
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Adopt furo theme for docs.
      Indicate to use latest Python version (workaround for readthedocs/readthedocs.org/#9623). Requires also specifying the OS version (workaround for readthedocs/readthedocs.org#9635).
      Test assertions directly
      ⚫ Fade to black.
      Fix long line
      Declare a type of 'type' for class_; addressing mypy failure.
      Create a mix-in for InitializedState
      Update tests to use existing files on disk. Fixes failing tests.
      Implement a more generalized parameterization function and use it for alpharep.
      Consolidate pickle tests into a single, parameterized test.
      Update changelog
      No need to construct a dict for the state.

Parker Hancock (2):
      create lazy loading lookup class to support pickling
      memoized form of pickling utility class and improved tests
clrpackages pushed a commit to clearlinux-pkgs/pypi-inflect that referenced this issue Oct 25, 2022
@fenrus75
pypi-inflect: Autospec creation for update from version 6.0.0 to vers…
557ab73 
…ion 6.0.1

Jason R. Coombs (18):
      Pin flake8. Workaround for tholo/pytest-flake8#87.
      Update to setup-python v4. Fixes jaraco/skeleton#65.
      Also update release to v4
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Adopt furo theme for docs.
      Indicate to use latest Python version (workaround for readthedocs/readthedocs.org/#9623). Requires also specifying the OS version (workaround for readthedocs/readthedocs.org#9635).
      GHA pretty env (#67)
      Clean up module docstring.
      Extract cases for indefinite articles.
      Prefer generator expression for indefinite article cases.
      Update docstring for joinstem; change example to doctest.
      Employ more_itertools.always_iterable for Optional[Iterable]
      Simply fall back to list when words is None. Saves dependency.
      Add doctests for None values.
      Convert examples in bysize to doctest.
      Use defaultdict in bysize.
      Update changelog

Zach Burnett (1):
      rename `.readthedocs.yml` to `.readthedocs.yaml` (RTD docs indicate that `.readthedocs.yml` will be deprecated) (#68)
clrpackages pushed a commit to clearlinux-pkgs/pypi-jaraco.text that referenced this issue Oct 25, 2022
@fenrus75
pypi-jaraco.text: Autospec creation for update from version 3.9.1 to …
bd057ff 
…version 3.10.0

Jason R. Coombs (7):
      Also update release to v4
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Adopt furo theme for docs.
      Indicate to use latest Python version (workaround for readthedocs/readthedocs.org/#9623). Requires also specifying the OS version (workaround for readthedocs/readthedocs.org#9635).
      GHA pretty env (#67)
      Prefer casefold in FoldedCase.

Zach Burnett (1):
      rename `.readthedocs.yml` to `.readthedocs.yaml` (RTD docs indicate that `.readthedocs.yml` will be deprecated) (#68)
clrpackages pushed a commit to clearlinux-pkgs/pypi-jaraco.collections that referenced this issue Oct 25, 2022
@fenrus75
pypi-jaraco.collections: Autospec creation for update from version 3.…
94bd3b8 
…5.2 to version 3.6.0

Jason R. Coombs (18):
      Use '-dev' for every Python version. Ref actions/setup-python#213.
      Use Python 3.11 for cutting releases.
      Pin flake8. Workaround for tholo/pytest-flake8#87.
      Update to setup-python v4. Fixes jaraco/skeleton#65.
      Also update release to v4
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Adopt furo theme for docs.
      Indicate to use latest Python version (workaround for readthedocs/readthedocs.org/#9623). Requires also specifying the OS version (workaround for readthedocs/readthedocs.org#9635).
      GHA pretty env (#67)
      Remove Python 2 compatibility in repr test.
      Add failing test for __contains__ on DictFilter.
      Revise DictFilter to rely on Mapping primitives. Fixes issue with `__contains__`.
      Add illustration in dictfilter on excluding items by prefix.
      Retain order in DictFilter
      Prefer pipe for symmetry.
      Rely on base class for DictFilter.values.
      Update changelog

Zach Burnett (1):
      rename `.readthedocs.yml` to `.readthedocs.yaml` (RTD docs indicate that `.readthedocs.yml` will be deprecated) (#68)
clrpackages pushed a commit to clearlinux-pkgs/pypi-keyring that referenced this issue Nov 8, 2022
@fenrus75
pypi-keyring: Autospec creation for update from version 23.9.3 to ver…
a988c32 
…sion 23.11.0

Christoph Reiter (1):
      libsecret: skip if there is no secret service running

Jason R. Coombs (7):
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Adopt furo theme for docs.
      Indicate to use latest Python version (workaround for readthedocs/readthedocs.org/#9623). Requires also specifying the OS version (workaround for readthedocs/readthedocs.org#9635).
      Bump requirement on importlib_metadata to 4.11.4. Fixes #526.
      Disable flake8 due to incompatibility.
      Update changelog

Matěj Cepl (1):
      Fix typo
clrpackages pushed a commit to clearlinux-pkgs/pypi-tempora that referenced this issue Nov 22, 2022
@fenrus75
pypi-tempora: Autospec creation for update from version 5.0.2 to vers…
0aace63 
…ion 5.1.0

Jason R. Coombs (20):
      Use '-dev' for every Python version. Ref actions/setup-python#213.
      Use Python 3.11 for cutting releases.
      Pin flake8. Workaround for tholo/pytest-flake8#87.
      Update to setup-python v4. Fixes jaraco/skeleton#65.
      Also update release to v4
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Adopt furo theme for docs.
      Indicate to use latest Python version (workaround for readthedocs/readthedocs.org/#9623). Requires also specifying the OS version (workaround for readthedocs/readthedocs.org#9635).
      GHA pretty env (#67)
      Pin mypy to '<0.990' due to realpython/pytest-mypy#141
      Remove the hyperlink for the Python versions badge. The PyPI badge is a better anchor for the hyperlink.
      Apply explicit_package_bases for mypy and unpin the version. Ref python/mypy#14057.
      Add Python 3.12 to matrix. Only test 3.8-3.10 on Linux.
      Disable flake8 on Python 3.12. Workaround for tholo/pytest-flake8#87.
      Update syntax
      Extract function 'infer_datetime'. Add some type annotations.
      Use algebra to construct subs in a single expression.
      Add type hints to _prorated_values.
      Update changelog.

Zach Burnett (1):
      rename `.readthedocs.yml` to `.readthedocs.yaml` (RTD docs indicate that `.readthedocs.yml` will be deprecated) (#68)
clrpackages pushed a commit to clearlinux-pkgs/pypi-jaraco.context that referenced this issue Nov 22, 2022
@fenrus75
pypi-jaraco.context: Autospec creation for update from version 4.1.2 …
44a3f37 
…to version 4.2.0

Jason R. Coombs (15):
      Use '-dev' for every Python version. Ref actions/setup-python#213.
      Use Python 3.11 for cutting releases.
      Pin flake8. Workaround for tholo/pytest-flake8#87.
      Update to setup-python v4. Fixes jaraco/skeleton#65.
      Also update release to v4
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Adopt furo theme for docs.
      Indicate to use latest Python version (workaround for readthedocs/readthedocs.org/#9623). Requires also specifying the OS version (workaround for readthedocs/readthedocs.org#9635).
      GHA pretty env (#67)
      Pin mypy to '<0.990' due to realpython/pytest-mypy#141
      Remove the hyperlink for the Python versions badge. The PyPI badge is a better anchor for the hyperlink.
      Apply explicit_package_bases for mypy and unpin the version. Ref python/mypy#14057.
      Add on_interrupt decorator.
      Add Python 3.7 compatibility.

Zach Burnett (1):
      rename `.readthedocs.yml` to `.readthedocs.yaml` (RTD docs indicate that `.readthedocs.yml` will be deprecated) (#68)
jaraco added a commit to jaraco/jaraco.vcs that referenced this issue Jun 20, 2023
@jaraco
When rendering docs, preserve the syntax for defaults. Fixes jaraco/p…
6c1b1ef 
…ath#197.

Incidentally, re-organize the extensions a bit for clarity.
clrpackages pushed a commit to clearlinux-pkgs/pypi-portend that referenced this issue Jun 29, 2023
@fenrus75
pypi-portend: Autospec creation for update from version 3.1.0 to vers…
5302ba3 
…ion 3.2.0

Anderson Bravalheri (2):
      Ignore flake8/black warnings with pytest 7.0.1 (jaraco/skeleton#58)
      Update Github actions to v3 (#62)

Hugo van Kemenade (1):
      Update base URL for PEPs (#61)

Jason R. Coombs (56):
      Remove filtered warnings, addressed upstream.
      Update badge year
      Remove setup.py, no longer needed.
      Add exclusions for pytest 7 deprecations in plugins. Fixes jaraco/skeleton#57.
      Use the parent category PytestDeprecationWarning, which is available on older pytest versions. Fixes jaraco/skeleton#57.
      Bump pytest-mypy and remove workaround for realpython/pytest-mypy#131.
      Require jaraco.packaging 9 adding compatibility for projects with no setup.py file.
      Ran pre-commit autoupdate
      Add Python 3.11 into the matrix using workaround from actions/setup-python#213. Drop 3.9 from matrix for efficiency.
      Prefer spaces for rst. Fixes jaraco/skeleton#64.
      Honor PEP 518 with pytest-enabler.
      Ran pre-commit autoupdate
      Use '-dev' for every Python version. Ref actions/setup-python#213.
      Use Python 3.11 for cutting releases.
      Pin flake8. Workaround for tholo/pytest-flake8#87.
      Update to setup-python v4. Fixes jaraco/skeleton#65.
      Also update release to v4
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Adopt furo theme for docs.
      Indicate to use latest Python version (workaround for readthedocs/readthedocs.org/#9623). Requires also specifying the OS version (workaround for readthedocs/readthedocs.org#9635).
      GHA pretty env (#67)
      Pin mypy to '<0.990' due to realpython/pytest-mypy#141
      Remove the hyperlink for the Python versions badge. The PyPI badge is a better anchor for the hyperlink.
      Apply explicit_package_bases for mypy and unpin the version. Ref python/mypy#14057.
      Add Python 3.12 to matrix. Only test 3.8-3.10 on Linux.
      Disable flake8 on Python 3.12. Workaround for tholo/pytest-flake8#87.
      Honor ResourceWarnings. Fixes jaraco/skeleton#73.
      tox 4 requires a boolean value, so use '1' to FORCE_COLOR. Fixes jaraco/skeleton#74.
      Remove unnecessary shebang and encoding header in docs conf.
      Prevent Python 3.12 from blocking checks.
      Build docs in CI, including sphinx-lint.
      Update badge for 2023
      ALLOW_UNICODE no longer needed on Python 3. As a result, ELLIPSES is also now enabled by default.
      Enable default encoding warning where available. See PEP 597.
      Suppress EncodingWarning in pytest_black. Workaround for shopkeep/pytest-black#67.
      Exempt warning. Workaround for realpython/pytest-mypy#152
      Add #upstream markers for filtered warnings. Add filter for platform module (ref python/cpython#100750).
      Remove reference to EncodingWarning as it doesn't exist on some Pythons.
      Revert "exclude build env from cov reporting (jaraco/skeleton#60)"
      Disable couldnt-parse warnings. Prescribed workaround for nedbat/coveragepy#1392. Fixes python/importlib_resources#279 and fixes jaraco/skeleton#56.
      Remove unnecessary and incorrect copyright notice. Fixes jaraco/skeleton#78.
      Replace flake8 with ruff. Fixes jaraco/skeleton#79 and sheds debt.
      Make substitution fields more prominent and distinct from true 'skeleton' references. (#71)
      Suppress EncodingWarning in build.env. Ref pypa/build#615.
      Remove reference to EncodingWarning as it doesn't exist on some Pythons.
      Update RTD boilerplate to new issue. Ref readthedocs/readthedocs.org#10401.
      Add badge for Ruff.
      Remove inclusion of python version for docs
      Adopt towncrier for managing changelog. Fixes jaraco/skeleton#83.
      Replace workaround for actions/setup-python#508 with 'allow-prereleases'
      Remove tox boilerplate, no longer necessary with later versions of tox.
      Require Python 3.8 or later.
      Expand 'finalize' to commit and tag the change.
      Leverage pytest-enabler 2.2 for the default config.
      Finalize

Joyce (1):
      Feat: initial permissions to main.yml (jaraco/skeleton#76)

Sviatoslav Sydorenko (1):
      Inject check job into CI workflow as ultimate flag (#55)

Zach Burnett (1):
      rename `.readthedocs.yml` to `.readthedocs.yaml` (RTD docs indicate that `.readthedocs.yml` will be deprecated) (#68)

wim glenn (1):
      exclude build env from cov reporting (#60)
clrpackages pushed a commit to clearlinux-pkgs/pypi-configparser that referenced this issue Jul 11, 2023
@fenrus75
pypi-configparser: Autospec creation for update from version 5.3.0 to…
9a3b92e 
… version 6.0.0

Jason R. Coombs (61):
      Add PyPy to the test matrix on Linux. Fixes jaraco/skeleton#63.
      When rendering docs, preserve the syntax for defaults. Fixes jaraco/path#197.
      Adopt furo theme for docs.
      Indicate to use latest Python version (workaround for readthedocs/readthedocs.org/#9623). Requires also specifying the OS version (workaround for readthedocs/readthedocs.org#9635).
      GHA pretty env (#67)
      Pin mypy to '<0.990' due to realpython/pytest-mypy#141
      Remove the hyperlink for the Python versions badge. The PyPI badge is a better anchor for the hyperlink.
      Apply explicit_package_bases for mypy and unpin the version. Ref python/mypy#14057.
      Add Python 3.12 to matrix. Only test 3.8-3.10 on Linux.
      Disable flake8 on Python 3.12. Workaround for tholo/pytest-flake8#87.
      Honor ResourceWarnings. Fixes jaraco/skeleton#73.
      tox 4 requires a boolean value, so use '1' to FORCE_COLOR. Fixes jaraco/skeleton#74.
      Remove unnecessary shebang and encoding header in docs conf.
      Prevent Python 3.12 from blocking checks.
      Run tests on Windows again. Fixes #58.
      Exclude Python 3.7 + Windows from the matrix as permanent workaround for #58.
      Build docs in CI, including sphinx-lint.
      Put tidelift docs dependency in its own section to limit merge conflicts.
      Remove 'configparser' as that renders the stdlib docs.
      Update badge for 2023
      ALLOW_UNICODE no longer needed on Python 3. As a result, ELLIPSES is also now enabled by default.
      Enable default encoding warning where available. See PEP 597.
      Suppress EncodingWarning in pytest_black. Workaround for shopkeep/pytest-black#67.
      Exempt warning. Workaround for realpython/pytest-mypy#152
      Add #upstream markers for filtered warnings. Add filter for platform module (ref python/cpython#100750).
      Remove reference to EncodingWarning as it doesn't exist on some Pythons.
      Revert "exclude build env from cov reporting (jaraco/skeleton#60)"
      Disable couldnt-parse warnings. Prescribed workaround for nedbat/coveragepy#1392. Fixes python/importlib_resources#279 and fixes jaraco/skeleton#56.
      ⚫ Fade to black.
      Remove unnecessary and incorrect copyright notice. Fixes jaraco/skeleton#78.
      Replace flake8 with ruff. Fixes jaraco/skeleton#79 and sheds debt.
      Make substitution fields more prominent and distinct from true 'skeleton' references. (#71)
      Suppress EncodingWarning in build.env. Ref pypa/build#615.
      Remove reference to EncodingWarning as it doesn't exist on some Pythons.
      Update RTD boilerplate to new issue. Ref readthedocs/readthedocs.org#10401.
      Add badge for Ruff.
      Remove inclusion of python version for docs
      Adopt towncrier for managing changelog. Fixes jaraco/skeleton#83.
      Replace workaround for actions/setup-python#508 with 'allow-prereleases'
      Remove tox boilerplate, no longer necessary with later versions of tox.
      Require Python 3.8 or later.
      Expand 'finalize' to commit and tag the change.
      Leverage pytest-enabler 2.2 for the default config.
      Prefer 3.x for Python version (latest stable).
      Collapse skeleton history. Workaround for jaraco/skeleton#87.
      Add links to project home page and pypi. Fixes jaraco/skeleton#77.
      Replace redundant step names with simple 'Run'.
      Increase visibility of security policy. (#4)
      Normalized headings in readme.
      👹 Feed the hobgoblins (delint).
      Bump exclusion to Python 3.8 now that Windows tests run there. Closes #67.
      Restore Windows tests on older Pythons (#68)
      Comment out just the option.
      cpython-v3.12.0b3 rev=f992a60014b7
      Apply pyupgrade for Python 3.8+ to test_backport.
      Move tests out of the package.
      Move package out of src
      Re-enable doctests now that pytest-dev/pytest#3396 is solved.
      Remove legacy support in configparser module.
      Skip unimportant coverage checks
      Finalize

Joyce (1):
      Feat: initial permissions to main.yml (jaraco/skeleton#76)

Zach Burnett (1):
      rename `.readthedocs.yml` to `.readthedocs.yaml` (RTD docs indicate that `.readthedocs.yml` will be deprecated) (#68)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement help wanted
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

test skeleton merge jaraco/googlevoice
2 participants
@jaraco @SethMMorton