You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'm using yamllint from Python because my YAML is frontmatter in Markdown files, so I have to parse it out before linting it and I have to say the API is bad/unpythonic. I would expect this
importyamllintyamllint.lint("foo: bar")
to work and use the default config, and I should not be required to make a YAMLConfig object (from a string!), I should be able to just pass a dictionary
also, https://yamllint.readthedocs.io/en/stable/development.html is still outdated after #699 which wasted some of my time and it also doesn't document all the properties of LintProblem. "Development" is also a confusing name for this section because "Development" in documentation usually refers to how to contribute to the underlying project, not how to use it. Also the readme should mention that there is a Python API, because I couldn't tell.
The text was updated successfully, but these errors were encountered:
I'm using yamllint from Python because my YAML is frontmatter in Markdown files, so I have to parse it out before linting it and I have to say the API is bad/unpythonic. I would expect this
to work and use the default config, and I should not be required to make a YAMLConfig object (from a string!), I should be able to just pass a dictionary
also, https://yamllint.readthedocs.io/en/stable/development.html is still outdated after #699 which wasted some of my time and it also doesn't document all the properties of
LintProblem
. "Development" is also a confusing name for this section because "Development" in documentation usually refers to how to contribute to the underlying project, not how to use it. Also the readme should mention that there is a Python API, because I couldn't tell.The text was updated successfully, but these errors were encountered: