darglint | python documentation linter which checks that the docstring | Code Analyzer library
kandi X-RAY | darglint Summary
kandi X-RAY | darglint Summary
A functional docstring linter which checks whether a docstring's description matches the actual function/method implementation. Darglint expects docstrings to be formatted using the Google Python Style Guide, or Sphinx Style Guide, or Numpy Style Guide. Feel free to submit an issue/pull request if you spot a problem or would like a feature in darglint.
Support
Quality
Security
License
Reuse
Top functions reviewed by kandi - BETA
- Extract types from section node
- Get the return type of the call
- Return a list of argument types
- Gets the lookup for a compound item type
- Parse a list of tokens
- Find the next two newline separators
- Return the end of a split end with indents
- Return the dot representation of the node
- Return an iterator over the nodes in this node
- Return a dot representation of the graph
- Return a log level from a string
- Extract value from node
- Return an iterator of style errors
- Translate the AST tree
- Get a list of items from a section
- Removes all nodes from the BFS tree
- Visit arguments
- Run the function
- Create an error report
- Get section node
- Reads the source file
- Visit a Try node
- Return a dot representation of a node
- Validate grammar
- Load a script
- Group the errors by function
darglint Key Features
darglint Examples and Code Snippets
Community Discussions
Trending Discussions on darglint
QUESTION
I'm trying to run flakehell as pre-commit hook.
my .pre-commit-config.yaml:
...ANSWER
Answered 2021-Jan-11 at 20:19your configuration is incorrect, you haven't limited the files that are passed to your hook with either files
or types
so it is defaulting to all files in your repository. presumably you have some binary file which is being passed to flakehell
I also notice that your configuration passes both a path and has pass_filenames: true
(pass_filenames: true
is the default so you shouldn't use that)
you either want to list paths in args (not recommended since you always lint more than what you're changing) or you want to filter the filenames properly
additionally, verbose: true
is not intended for use outside of debugging as it adds warning noise to the output
additionally, you're not managing the installation of flakehell through pre-commit which will add additional burden to your contributors to try and set up whatever development environment locally, most of the point of pre-commit is that it manages installing your tools so your contributors don't have to jump through hoops to have the correct formatting / linting setup (eliminating a whole class of "it works on my machine" problems)
additionally, it looks like flakehell has direct support for pre-commit, so you don't need to use the repo: local
escape hatch as you're doing
putting all of that together, you probably want something like this:
Community Discussions, Code Snippets contain sources that include Stack Exchange Network
Vulnerabilities
No vulnerabilities reported
Install darglint
Install darglint. First, clone the repository:.
Support
Reuse Trending Solutions
Find, review, and download reusable Libraries, Code Snippets, Cloud APIs from over 650 million Knowledge Items
Find more librariesStay Updated
Subscribe to our newsletter for trending solutions and developer bootcamps
Share this Page