docs: fix typos, spelling and docstring formatting in vectorisers#195
docs: fix typos, spelling and docstring formatting in vectorisers#195jamie-ons wants to merge 5 commits into
Conversation
rileyok-ons
left a comment
There was a problem hiding this comment.
Ran it over with some stricter doc linting, seems great, got a couple newlines you need after the docstring summary, https://docs.astral.sh/ruff/rules/missing-blank-line-after-summary/ checked and its part of the google python style guide https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
A docstring should be organized as a summary line (one physical line not exceeding 80 characters) terminated by a period, question mark, or exclamation point. We currently have an ignore for this rule in our ruff config when actually we shouldn't, I'm going to remove it in my changes
|
Have added the new lines. However have noticed that most one line summaries are over 80 characters. Should I rewrite all summaries to be <=80 characters. This would make it comply fully with the google python style guide but also seems quite strict? We dont have any that are so long that they are unreadable but for example
This is 86 characters long and so wouldnt comply |
Checked and current idea is we're not strict on the line length |
|
As an additional thing can you add types to the ABC vectorizser docstring |
✨ Summary
Tidy up docstrings across the
vectorisersmodule📜 Changes Introduced
__init__.pymodule overview to be consistent withbase.pyas they were near identical apart from a few words.✅ Checklist
terraform fmt&terraform validate)🔍 How to Test
__init__.pyhasn't / wont cause issues with quarto (i changed * -> - for bullet pointing to be consistent with base.py.