Improve Documentation of CSVLintBear #2884

chay2199 · 2019-03-05T14:28:22Z

Provide some more details on what
respects the csv file is being validated.

For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!

Checklist

I read the commit guidelines and I've followed
them.
I ran coala over my code locally. (All commits have to pass
individually. It is not sufficient to have "fixup commits" on your PR,
our bot will still report the issues for the previous commit.) You will
likely receive a lot of bot comments and build failures if coala does not
pass on every single commit!

After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.

Please consider helping us by reviewing other peoples pull requests as well:

pick up any PR at https://coala.io/review
review it (check https://coala.io/reviewing for more info)
if you are sure that it needs work, use corobo mark wip <URL> to get it out
of the review queue.

The more you review, the more your score will grow at coala.io and we will
review your PRs faster!

KVGarg · 2019-03-07T17:08:42Z

bears/csv/CSVLintBear.py

+    - against multiple schema standards; CSV on the Web
+
+    Find out more at:
+    <https://github.com/theodi/csvlint.rb/blob/master/README.md>


Is this link necessary ?

Not necessary but it can provide more information about the validation process. So should I remove it?

If it gives more information, then OK 👍

KVGarg · 2019-03-07T17:09:11Z

bears/csv/CSVLintBear.py

@@ -9,6 +9,15 @@
 class CSVLintBear:  # pragma nt: no cover
    """
    Verifies using ``csvlint`` if ``.csv`` files are valid CSV or not.
+    The ``CSVLintBear`` has validation that checks:


IMO has -> does

KVGarg · 2019-03-07T17:12:07Z

bears/csv/CSVLintBear.py

+    - delimiter-separated values (dsv) file accessible via URL, File,
+    or an IO-style object (e.g. StringIO)
+    - against CSV dialects
+    - against multiple schema standards; CSV on the Web


What does CSV on the web means ?

CSV on the web provides standard ways to express useful metadata about CSV files and other kinds of tabular data.

So, it isn't a validation check right ?

Just replace semi-colon with and to differentiate between “ schema standards“ and “csv on the web”
Because both of them are different

bkhanale · 2019-03-07T20:04:27Z

bears/csv/CSVLintBear.py

+    - against multiple schema standards; CSV on the Web
+
+    Find out more at:
+    <https://github.com/theodi/csvlint.rb/blob/master/README.md>


Use SEE_MORE.

@bkhanale so you want me to replace "Find out more at:" with "SEE_MORE" followed by the link?

git grep SEE_MORE. You can find lot of examples.

Got it! Thanks for the review.

areebbeigh · 2019-03-08T03:31:03Z

bears/csv/CSVLintBear.py

@@ -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,


Suggested change

- delimiter-separated values (dsv) file accessible via URL, File,

- delimiter-separated values (DSV) file accessible via URL, File,

areebbeigh · 2019-03-08T03:32:43Z

bears/csv/CSVLintBear.py

+    - delimiter-separated values (dsv) file accessible via URL, File,
+    or an IO-style object (e.g. StringIO)
+    - against CSV dialects
+    - against multiple schema standard and CSV on the Web


Suggested change

- against multiple schema standard and CSV on the Web

- against multiple schema standards and CSV on the Web

frextrite

Change commit title(additionally the PR title) to reflect which file is being updated in the current PR

Provide some more details on what respects the csv file is being validated. Closes #2277

bkhanale

You need to squash commits into one.

KVGarg · 2019-03-18T08:37:33Z

bears/csv/CSVLintBear.py

+    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)


need alignment of sentences in one column.

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

Yes, need a tab space before “or”

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

Ok 👍🏻

KVGarg

LGTN 💯

jayvdb · 2019-07-21T14:13:50Z

Needs a rebase

jayvdb · 2019-08-22T04:20:23Z

@chay2199 please rebase!

chay2199 · 2019-08-22T06:19:36Z

@jayvdb @li-boxuan I am extremely sorry, but my fork of coala-bears repo got corrupted and it no longer exists now. This PR is without a parent, please close this one and I'll make a new one for the same issue.

gitmate-bot added process/pending review size/XS area/documentation difficulty/low labels Mar 5, 2019

gitmate-bot assigned chay2199 Mar 5, 2019

KVGarg reviewed Mar 7, 2019

View reviewed changes

KVGarg suggested changes Mar 7, 2019

View reviewed changes

KVGarg reviewed Mar 7, 2019

View reviewed changes

bkhanale requested changes Mar 7, 2019

View reviewed changes

areebbeigh suggested changes Mar 8, 2019

View reviewed changes

frextrite suggested changes Mar 8, 2019

View reviewed changes

chay2199 changed the title ~~Improve documentation of CSVLintBear~~ CSVLintBear.py: Improve Documentation Mar 8, 2019

chay2199 changed the title ~~CSVLintBear.py: Improve Documentation~~ Improve Documentation of CSVLintBear Mar 8, 2019

chay2199 closed this Mar 8, 2019

li-boxuan reopened this Mar 9, 2019

CSVLintBear.py: Improve Documentation

09e754d

Provide some more details on what respects the csv file is being validated. Closes #2277

bkhanale requested changes Mar 9, 2019

View reviewed changes

KVGarg suggested changes Mar 18, 2019

View reviewed changes

KVGarg approved these changes Mar 18, 2019

View reviewed changes

jayvdb added process/approved and removed process/pending review labels Jul 21, 2019

chay2199 closed this Aug 22, 2019

chay2199 mentioned this pull request Aug 22, 2019

CSVLintBear.py: Improve Documentation #2953

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve Documentation of CSVLintBear #2884

Improve Documentation of CSVLintBear #2884

chay2199 commented Mar 5, 2019 •

edited

Loading

KVGarg Mar 7, 2019

chay2199 Mar 7, 2019

KVGarg Mar 7, 2019

KVGarg Mar 7, 2019

KVGarg Mar 7, 2019

chay2199 Mar 7, 2019

KVGarg Mar 7, 2019

chay2199 Mar 7, 2019

KVGarg Mar 7, 2019 •

edited

Loading

bkhanale Mar 7, 2019

chay2199 Mar 7, 2019

bkhanale Mar 7, 2019

chay2199 Mar 7, 2019

areebbeigh Mar 8, 2019

areebbeigh Mar 8, 2019

frextrite left a comment

bkhanale left a comment

KVGarg Mar 18, 2019

chay2199 Mar 18, 2019

KVGarg Mar 18, 2019

chay2199 Mar 18, 2019 •

edited

Loading

KVGarg Mar 18, 2019

KVGarg left a comment

jayvdb commented Jul 21, 2019

jayvdb commented Aug 22, 2019

chay2199 commented Aug 22, 2019

	- delimiter-separated values (dsv) file accessible via URL, File,
	- delimiter-separated values (DSV) file accessible via URL, File,

	- against multiple schema standard and CSV on the Web
	- against multiple schema standards and CSV on the Web

Improve Documentation of CSVLintBear #2884

Improve Documentation of CSVLintBear #2884

Conversation

chay2199 commented Mar 5, 2019 • edited Loading

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KVGarg Mar 7, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frextrite left a comment

Choose a reason for hiding this comment

bkhanale left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chay2199 Mar 18, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KVGarg left a comment

Choose a reason for hiding this comment

jayvdb commented Jul 21, 2019

jayvdb commented Aug 22, 2019

chay2199 commented Aug 22, 2019

chay2199 commented Mar 5, 2019 •

edited

Loading

KVGarg Mar 7, 2019 •

edited

Loading

chay2199 Mar 18, 2019 •

edited

Loading