-
Notifications
You must be signed in to change notification settings - Fork 107
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Pretty print function signatures #78
Merged
NiklasRosenstein
merged 1 commit into
NiklasRosenstein:master
from
lgeiger:pretty-print-signature
Apr 2, 2019
Merged
Pretty print function signatures #78
NiklasRosenstein
merged 1 commit into
NiklasRosenstein:master
from
lgeiger:pretty-print-signature
Apr 2, 2019
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
Thanks, looks cool! :-) |
Hi, I just ran into failing builds, apparently caused by
I had to pin to Full failing build traceback: https://travis-ci.org/bocadilloproject/bocadillo/builds/515720068 |
NiklasRosenstein
added a commit
that referenced
this pull request
Feb 28, 2022
* mypy and adjust to docspec-2.0.0 alpha * mypy with untyped defs * add more type hints * update project and ci * update workflow * update workflow * fix project config * bump dependency on 2.0.0a1 * update type hint * depend on tomli and tomli_w * fix hwo the markdown renderer identifies the header level (broke due to docspec upgrade) * hygiene: remove `MarkdownRenderer.classdef_render_init_signature_if_needed` option because it never worked to begin with * breaking change: remove `MarkdownRenderer.render_to_stream()` from public api * add missing types-* dependencies * add jinja dep * clean some deps * use is_relative_to from nr.util.fs for 3.8 and 3.7 compatibility * bump * start updating docs to build them with Novella * remove .readthedocs.yml * add to docs/requirements.txt * update docs * need novella==0.1.5 at least * convert changelogs * add PR links * install pydoc-markdown in docs build * first implementation of `@pydoc` tag * move novella dep to "novella" extra, add "docs" extra * update ci * enable pushing to gh pages * fix syntax in pyproject.toml * fix mypy * need to exclude pydoc_markdown.novella for now because we cant verify it in 3.7-3.9 python versions * add using-novella.md * spell * automatically detect source linker config for github.com, gitlab.com and gitea.com * remove unused import * feature: add `pydoc_markdown.interfaces.SingleObjectRenderer` and use it in Novella `@pydoc` tag processor * features * mypy * move accidentally ill-located changelogs for 4.4.0 to correct file * implement `@pylink` tag * feature: bring back formatting function, class and variable signatures with YAPF. (Tagging @lgeiger as the author because he was the original author of the feature in a previous version of Pydoc-Markdown, see #78) closes #244 * add yapf dependency * ignore types for yapf * fix: fix forwarding of `PluginBase.init()` calls to sub-plugins in unittests and `DocusaurusRenderer` * update function signature style (no trailing colon) * update docs * git fetch before building docs * update pr numbers from ci * fix update-pr-numbers * Update changelog PR references * Update .changelog/_unreleased.toml * update git describe in index.md * remove pydoc-markdown.yml, disable render_module_header by default for MarkdownRenderer in @pydoc tag, fetch tags as well * use fetch-depth: 0 to make git describe --tag work * use GITHUB_HEAD_REF is available * fix links to source code (hopefully) * fix ci * improvement: do not render link to source for modules in `MarkdownRenderer` * Update changelog PR references * cache loaded modules in Pydoc preprocessor, use new `MarkdownPreprocessorAction.repeat()` on generated Markdown code * bump novella dep * <3.10 syntax Co-authored-by: GitHub Action <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 auto-formats function signatures. This is makes very long function signatures a lot more readable.
Before
After
Why using yapf?