Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

WIP: point Sphinx directly at real modules#415

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.

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

Already on GitHub?Sign in to your account

Draft
djpohly wants to merge2 commits intopyparsing:master
base:master
Choose a base branch
Loading
fromdjpohly:at-least-i-learned-something

Conversation

djpohly
Copy link
Contributor

See comments in#411.

This requires "annotations" from __future__, which doesn't exist inPython 3.6.  Might be nice to have someday though.
@ptmcg
Copy link
Member

I'm inclined to keep thereplaced_by_pep8 decorator, as it gives a good place to emit a DeprecationWarning when I do the 3.1.0 release.

@djpohly
Copy link
ContributorAuthor

That makes sense. What would you think about still referencing the individual modules directly for Sphinx? It would make it more straightforward to include documentation for module-level variables likealphanums,empty,common_html_entity, orParseAction.

The alternative, if we wanted to document any variables, would be to put their documentation directly in__init__.py, separate from the actual definition. Either of the following options would keep mypy happy:

common_html_entity:ParserElement=common_html_entity"""Convenience parser for common HTML entities"""
common_html_entity:ParserElement# type: ignore[no-redef]"""Convenience parser for common HTML entities"""

@ptmcg
Copy link
Member

Looking at this, but late now - will pick up some time tomorrow.

@ptmcg
Copy link
Member

Please don't remove the replaced_by_pep8 decorators. As I said, I'm going to use those to emit DeprecationWarnings starting in pyparsing 3.1.0

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

2 participants
@djpohly@ptmcg

[8]ページ先頭

©2009-2025 Movatter.jp