Glob_Patterns.rst: Remove redundant examples #187

aptrishu · 2016-10-13T11:29:23Z

It removes some unnecessary examples.

Closes #70

gitmate-bot · 2016-10-13T11:29:35Z

Thanks for your contribution!

Reviewing pull requests take really a lot of time and we're all volunteers. Please make sure you go through the following check list and complete them all before pinging someone for a review.

I have rebased properly. Please see this for a tutorial.
I have gone through the commit guidelines and I've followed them:
- I have followed the guidelines for the commit shortlog.
- I have followed the guidelines for the commit body.
- I have included the issue URL.
- I have used the Fixes keyword if the commit fixes a real bug and the Closes keyword if it adds a feature/enhancement. See more here.
I have run all the tests and they all pass. That includes that all CI (below) is green - if GitMate issues appear you will have to amend your commits, pushing new commits on top is not sufficient!

As you learn things over your Pull Request please help others on the chat and on PRs to get their stuff right as well!

Nosferatul · 2016-10-13T11:49:07Z

Hi! Fixes -> Closes. We use Fixes for bugs! The commit looks good to me!

aptrishu · 2016-10-13T11:53:25Z

I have updated the commit. @Nosferatul

Nosferatul · 2016-10-15T11:35:04Z

The commit message looks good to me 👍

Nosferatul · 2016-10-15T11:42:28Z

Users/Glob_Patterns.rst

@@ -123,14 +121,10 @@ brackets. Parentheses that have no match are ignored as well as
 False


We could delete this example too. I don't find the purpose of it. This is my opinion. Don't do it until someone else says that it's ok.

It justifies the statement that [!seq] here seq cannot be empty . If the seq is empty than no matter what pattern are you matching it with, it'll always return false. unless the string and pattern are exactly same. i.e;
if I do
fnmatch("a[!]a","a[!]a")
It will return true. :)

Why isnt [!] an error, or a noisy warning?
It is confusing to list it here, without explanation that this is invalid syntax.

So, should I add an explanation for that in there ? @jayvdb

It's not a kind of error, I think. and as far as its output is concerned it's explained in the docs.

aptrishu

I have deleted only that much examples which are unnecessary and rest examples should be there to justify every pattern.

aptrishu · 2016-10-15T13:49:47Z

Users/Glob_Patterns.rst

@@ -123,14 +121,10 @@ brackets. Parentheses that have no match are ignored as well as
 False


It justifies the statement that [!seq] here seq cannot be empty . If the seq is empty than no matter what pattern are you matching it with, it'll always return false. unless the string and pattern are exactly same. i.e;
if I do
fnmatch("a[!]a","a[!]a")
It will return true. :)

aptrishu · 2016-10-16T11:41:47Z

Please review now. @Adrianzatreanu

sils · 2016-10-18T10:27:57Z

CC @fneu can you take a look? This looks still like way too many examples to me. I'd remove them all and think from scratch which examples are actually useful and add them with explanations.

aptrishu · 2016-10-21T13:22:02Z

Should I explain every example what it stands for ? I can do that because I have kept only those examples which are necessary. @Nosferatul @sils @Adrianzatreanu

sils · 2016-10-25T18:24:31Z

How did you define "necessary"?

aptrishu · 2016-10-25T18:49:39Z

Every example that is there is only because it has a concept associated with it which can't be understood unless we show them that example. Like for example

[!seq] here seq cannot be empty . If the seq is empty than no matter what pattern are you matching it with, it'll always return false. unless the string and pattern are exactly same. i.e;
if I do
fnmatch("a[!]a","a[!]a")
It will return true.
fnmatch("aa","a[!]a")
returns false;
So, here I could only show the second example for the meaning of [!seq] but they need to know that if the seq and pattern are exactly the same then it'll always return true.

sils · 2016-10-25T23:22:08Z

IMO if every example has a meaning as documentation we should have some text explaining them

sils · 2016-10-25T23:22:14Z

CC @fneu

Nosferatul · 2016-10-26T08:51:01Z

Yes, we should explain some examples so that the user would understand faster.

adtac

LGTM to me except for the one comment. Patch it and I'll ack it 👍

adtac · 2016-10-26T10:24:35Z

Users/Glob_Patterns.rst

@@ -180,8 +174,6 @@ brackets. Parentheses that have no match are ignored as well as
 True


I'd say we can remove L177 too (fnmatch("abc", "a*c")) since that is anyway covered with abbc.

It shows * can also work as ? . and can match more than one characters as well. Removing it though.

Done @adtac . I removed that line.

aptrishu · 2016-10-26T12:13:50Z

Can you explain a little ? @Nosferatul @sils

aptrishu · 2016-11-07T12:22:48Z

Sorry, closed the pull request by mistake. I have reopened it.

AbdealiLoKo · 2016-11-10T03:36:53Z

Users/Glob_Patterns.rst

+
+.. note::
+
+ If you don't know the fuctions of a bear or how to perform the analysis


Functions - typo.

AbdealiLoKo · 2016-11-10T03:41:14Z

Users/Glob_Patterns.rst

+
+ coala --files='src/*.c' --bears=SpaceConsistencyBear --save
+
+Here, ``*.c`` matches all ``.c`` files in the specified directory.


Mention src instead of specified directory to be clearer

AbdealiLoKo · 2016-11-10T03:51:34Z

Users/Glob_Patterns.rst

+
+.. note::
+
+ While using ``files = **/*.c`` , since we have used ``\`` in the glob


Unusual space before comma

I don't understand this note. Where is backslash used? Why will directories below root be matched?

it should be / I think

adtac · 2016-11-10T04:31:04Z

Users/Glob_Patterns.rst

+Using Glob Patterns
+-------------------
+
+Suppose you want `SpaceConsistencyBear` to perform an analysis on a file


doubleticks?

adtac · 2016-11-10T04:31:44Z

Users/Glob_Patterns.rst

+
+.. note::
+
+ While using ``files = **/*.c`` , since we have used ``\`` in the glob


it should be / I think

adtac · 2016-11-10T04:32:20Z

Users/Glob_Patterns.rst

+.. note::
+
+ While using ``files = **/*.c`` , since we have used ``\`` in the glob
+ pattern so all ``.c`` files at least one subdirectory below the root


I don't think using a so is valid when you begin a phrase with since? Not sure, others can chip in.

No, we shouldn't. I searched at english.stackexachange.

aptrishu · 2016-11-10T05:08:13Z

did the changes. @AbdealiJK @adtac

arjunsinghy96

@aptrishu @adtac redundant '' are also present throughout the page .. rest seems fine to me.

arjunsinghy96 · 2016-11-11T14:53:56Z

Users/Glob_Patterns.rst

@@ -174,14 +209,10 @@ brackets. Parentheses that have no match are ignored as well as



@aptrishu remove the redundant '' before special characters.

Where did you find the redundant ''? to be exact ? @arjunsinghy96

line 219 it is \*\* whereas it should be ** (The subheading). And may other occurrences are there. As this is not related to the issue, it is up to you if you want to do it.

Every '*' is an special character should be preceded by '' , unless used inside the quotes.' '

grave accent ``` is different from Apostrophe '. We use grave accent to highlight text not apostrophe. And under grave accent `*` is not a special character. Therefore, no need of `` .

I think the heading there displays pattern the same way it should be used. I don't think it's about highlighting thing. (it's fine `` highlights the content, and it has no trouble being used with ) but coming to usage of glob pattern, while using in command line we should provide \ before each *.

But following the wildcards of os , we don't need to use \ before each * .
**\ should be fine.

\ is not required before * in command line i guess

sils · 2016-11-14T17:40:13Z

ack fd9e6d7

sils · 2016-11-14T17:40:33Z

time to get this merged @aptrishu can you rebase and ping so we merge it?

It removes some unnecessary examples and adds some examples showing the usage of glob patterns. Closes coala#70

sils · 2016-11-14T17:45:29Z

reack 2d070c6

sils · 2016-11-14T17:45:32Z

@rultor merge

rultor · 2016-11-14T17:46:46Z

@rultor merge

@sils OK, I'll try to merge now. You can check the progress of the merge here

rultor · 2016-11-14T17:48:18Z

@rultor merge

@sils Done! FYI, the full log is here (took me 1min)

gitmate-bot added process/pending review size/XS labels Oct 13, 2016

aptrishu force-pushed the issue4 branch from 7bd9c7f to cb9194b Compare October 13, 2016 11:52

Nosferatul reviewed Oct 15, 2016

View reviewed changes

aptrishu commented Oct 15, 2016

View reviewed changes

aptrishu force-pushed the issue4 branch 2 times, most recently from ba18a77 to 24103fb Compare October 16, 2016 11:24

aptrishu changed the title ~~Glob_Patterns.rst: Modify the examples~~ Glob_Patterns.rst: Remove redundant examples Oct 16, 2016

Nosferatul added process/wip and removed process/pending review labels Oct 19, 2016

aptrishu force-pushed the issue4 branch from 24103fb to 8b7b14e Compare October 19, 2016 16:53

gitmate-bot added process/pending review and removed process/wip labels Oct 19, 2016

aptrishu force-pushed the issue4 branch from 8b7b14e to a8809ce Compare October 26, 2016 00:21

adtac requested changes Oct 26, 2016

View reviewed changes

adtac added process/wip and removed process/pending review labels Oct 26, 2016

aptrishu closed this Nov 7, 2016

aptrishu reopened this Nov 7, 2016

aptrishu force-pushed the issue4 branch from 6b05d31 to 1859dc7 Compare November 7, 2016 12:24

adtac approved these changes Nov 7, 2016

View reviewed changes

aptrishu force-pushed the issue4 branch from 1859dc7 to f439c49 Compare November 8, 2016 23:02

AbdealiLoKo requested changes Nov 10, 2016

View reviewed changes

AbdealiLoKo added process/wip and removed process/pending review labels Nov 10, 2016

adtac reviewed Nov 10, 2016

View reviewed changes

aptrishu force-pushed the issue4 branch from f439c49 to c216547 Compare November 10, 2016 05:07

gitmate-bot added process/pending review and removed process/wip labels Nov 10, 2016

aptrishu force-pushed the issue4 branch from c216547 to fd9e6d7 Compare November 10, 2016 15:11

arjunsinghy96 suggested changes Nov 11, 2016

View reviewed changes

sils added process/approved and removed process/pending review labels Nov 14, 2016

Glob_Patterns.rst: Remove redundant examples

2d070c6

It removes some unnecessary examples and adds some examples showing the usage of glob patterns. Closes coala#70

aptrishu force-pushed the issue4 branch from fd9e6d7 to 2d070c6 Compare November 14, 2016 17:44

gitmate-bot added the process/pending review label Nov 14, 2016

sils removed the process/pending review label Nov 14, 2016

rultor merged commit 2d070c6 into coala:master Nov 14, 2016

		@@ -123,14 +121,10 @@ brackets. Parentheses that have no match are ignored as well as
		False

		@@ -180,8 +174,6 @@ brackets. Parentheses that have no match are ignored as well as
		True


		.. note::

		If you don't know the fuctions of a bear or how to perform the analysis


		coala --files='src/*.c' --bears=SpaceConsistencyBear --save

		Here, ``*.c`` matches all ``.c`` files in the specified directory.


		.. note::

		While using ``files = */.c`` , since we have used ``\`` in the glob

		@@ -174,14 +209,10 @@ brackets. Parentheses that have no match are ignored as well as

Glob_Patterns.rst: Remove redundant examples #187

Glob_Patterns.rst: Remove redundant examples #187

Conversation

aptrishu commented Oct 13, 2016 • edited Loading

gitmate-bot commented Oct 13, 2016

Nosferatul commented Oct 13, 2016

aptrishu commented Oct 13, 2016

Nosferatul commented Oct 15, 2016

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

aptrishu Nov 11, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aptrishu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aptrishu commented Oct 16, 2016

sils commented Oct 18, 2016

aptrishu commented Oct 21, 2016

sils commented Oct 25, 2016 via email

aptrishu commented Oct 25, 2016

sils commented Oct 25, 2016

sils commented Oct 25, 2016

Nosferatul commented Oct 26, 2016

adtac 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

aptrishu commented Oct 26, 2016

aptrishu commented Nov 7, 2016

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

Choose a reason for hiding this comment

aptrishu commented Nov 10, 2016

arjunsinghy96 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aptrishu Nov 11, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sils commented Nov 14, 2016

sils commented Nov 14, 2016

sils commented Nov 14, 2016

sils commented Nov 14, 2016

rultor commented Nov 14, 2016

rultor commented Nov 14, 2016

aptrishu commented Oct 13, 2016 •

edited

Loading

aptrishu Nov 11, 2016 •

edited

Loading

aptrishu Nov 11, 2016 •

edited

Loading