Skip to content
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.

Sign up for GitHub

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

Improve Documentation of CSVLintBear #2884

Closed
wants to merge 1 commit into from
Closed

Improve Documentation of CSVLintBear #2884

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions bears/csv/CSVLintBear.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@
class CSVLintBear: # pragma nt: no cover
"""
Verifies using ``csvlint`` if ``.csv`` files are valid CSV or not.
The ``CSVLintBear`` does validation that checks:
- structural formatting of a CSV file
- delimiter-separated values (DSV) file accessible via URL, File,
or an IO-style object (e.g. StringIO)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need alignment of sentences in one column.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KVGarg I can't understand you properly. Are you talking about the misalignment of line no. 15?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, need a tab space before “or”

Copy link
Contributor Author

@chay2199 chay2199 Mar 18, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was like that early on but coala or some build showed an error because of it. That is why I changed it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok 👍🏻

- against CSV dialects
- against multiple schema standards and CSV on the Web
"""

LANGUAGES = {'CSV'}
Expand All @@ -18,6 +24,7 @@ class CSVLintBear: # pragma nt: no cover
LICENSE = 'AGPL-3.0'
CAN_DETECT = {'Syntax'}
ASCIINEMA_URL = 'https://asciinema.org/a/8fmp2pny34kpqw7t1eoy7phhc'
SEE_MORE = 'https://github.com/theodi/csvlint.rb/blob/master/README.md'

regex = re.compile(r'\n\d+\.\s(?P<origin>(?P<severity>\w+))\.\s'
r'(Row:\s(?P<line>[0-9]+)\.\s)?(?P<message>.*)?')
Expand Down