Tutorial.rst: Change documentation about .coafile #510

Rahmeen14 · 2017-12-16T19:17:08Z

Replaced the deprecated [Default] section by [cli]. Also, assigned True to use_spaces instead of yeah.
These changes were made because the previous documentation was inconsistent with the observation upon execution of coala.
Fixes coala/coala#4968

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 cobot 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!

Rahmeen14 · 2017-12-16T19:23:30Z

Hi! I have tried to fix the issue coala/coala#4968 assigned to me. Could it be reviewed, please? This is my first attempt at a PR. I hope to learn a lot from here. Thanks!

ishanSrt

Its not a bug so use Closes instead of Fixes

ishanSrt · 2017-12-17T17:13:37Z

Use git commit --amend and then force push your changes

ishanSrt · 2017-12-17T17:16:16Z

Also the expected results says to use yeah but you have changed it to true

ishanSrt · 2017-12-17T17:17:29Z

unack e8c2d09

Rahmeen14 · 2017-12-17T17:28:50Z

@ishanSrt I'll change 'fixes' to 'Closes', thank you for pointing that out.
The edit however was intended to change the documentation so that it may conform to the actual result we obtain on opening the .coafile following the getting started guide rather the deprecated one which had been documented. The PR attempted to document the actual results, i.e, true instead of the deprecated yeah

ishanSrt · 2017-12-17T17:40:15Z

Great!

RaiVaibhav

@Rahmeen14 replace true with True as per line 67 in https://github.com/coala/documentation/edit/master/Users/Tutorial.rst
we are passing True not true , also make a Note (because in many places they have given an example with the help of Default section , but if newcomer read all those he will get confused as he don't get what exactly is Default Section after current changes on your commit) of

Default section is now deprecated (--> its inheritance features),

RaiVaibhav · 2017-12-17T17:54:01Z

@ishanSrt

Also the expected results says to use yeah but you have changed it to true

that is the expected results it depends what we passed , but on Tutorial we passed True :)

Rahmeen14 · 2017-12-17T17:58:35Z

@RaiVaibhav Thanks for the review. I'll make the changes! For the other statements about the default section, do I add the required note right in the beginning of the tutorial?

RaiVaibhav · 2017-12-17T18:05:35Z

Imo in between line 159 and 161 will be better

Rahmeen14 · 2017-12-17T18:06:32Z

Will do it! Thank you once again! :)

Rahmeen14 · 2017-12-17T18:23:19Z

@RaiVaibhav I have made the desired changes, could you please review it once?
So sorry for bothering you again. Thanks for your time!

ishanSrt · 2017-12-17T18:25:47Z

wouldn't it be better to change all references of [Default] section to [cli] section than just referencing its depreciation?

ishanSrt · 2017-12-17T18:33:42Z

Anyways I would recommend making that Note bold and also mention that we are using [cli] instead of (--> its inheritance features)

Rahmeen14 · 2017-12-17T18:37:02Z

@ishanSrt I have followed the same format as goes for other notes in that .rst file. I don't think bolding it explicitly should be necessary.

Makman2 · 2018-01-15T15:55:36Z

Could you remove the space before the colon in the shortlog? Also please describe the reason of this change in the commit body so somebody can immediately understand why this is done (due to inconsistencies).

Makman2 · 2018-01-15T15:55:50Z

unack 01ccab0

Rahmeen14 · 2018-01-16T15:20:28Z

Have made the required changes. @Makman2 I'm sorry for bothering you again but can you please review it?

ishanSrt

Commit body, terminate sentences with full stops

Rahmeen14 · 2018-01-16T16:00:59Z

@ishanSrt Thank you, have made the necessary changes.

ishanSrt · 2018-01-16T16:06:40Z

👍 LGTM

Makman2 · 2018-01-16T19:29:26Z

ack 5ab3f3f

jayvdb · 2018-03-10T03:32:11Z

@gitmate-bot rebase

Replaced the deprecated [Default] section by [cli]. Assigned True to use_spaces instead of yeah. These changes were made because the previous documentation was inconsistent with the observation upon execution of coala. Closes coala/coala#4968

gitmate-bot · 2018-03-10T03:32:13Z

Hey! I'm GitMate.io! This pull request is being rebased automatically. Please DO NOT push while rebase is in progress or your changes would be lost permanently ⚠️

gitmate-bot · 2018-03-10T03:32:22Z

Automated rebase with GitMate.io was successful! 🎉

jayvdb · 2018-03-10T03:36:48Z

@gitmate-bot ff

gitmate-bot · 2018-03-10T03:36:50Z

Hey! I'm GitMate.io! This pull request is being fastforwarded automatically. Please DO NOT push while fastforward is in progress or your changes would be lost permanently ⚠️

gitmate-bot · 2018-03-10T03:36:59Z

Automated fastforward with GitMate.io was successful! 🎉

gitmate-bot added process/pending review size/XS labels Dec 16, 2017

Rahmeen14 force-pushed the mybranch branch 2 times, most recently from ba31db4 to e8c2d09 Compare December 17, 2017 06:55

gitmate-bot added area/documentation difficulty/newcomer importance/high labels Dec 17, 2017

gitmate-bot assigned Rahmeen14 Dec 17, 2017

ishanSrt suggested changes Dec 17, 2017

View reviewed changes

Rahmeen14 force-pushed the mybranch branch from e8c2d09 to 5ceba16 Compare December 17, 2017 17:34

RaiVaibhav reviewed Dec 17, 2017

View reviewed changes

gitmate-bot added process/approved and removed process/pending review labels Dec 17, 2017

Rahmeen14 force-pushed the mybranch branch from 5ceba16 to 324e7e3 Compare December 17, 2017 18:20

gitmate-bot added process/pending review and removed process/approved labels Dec 17, 2017

newbazz approved these changes Jan 13, 2018

View reviewed changes

Rahmeen14 force-pushed the mybranch branch 2 times, most recently from 6ba1fa0 to fead2f5 Compare January 16, 2018 15:17

Rahmeen14 changed the title ~~Tutorial.rst : Change documentation about .coafile~~ Tutorial.rst: Change documentation about .coafile Jan 16, 2018

ishanSrt suggested changes Jan 16, 2018

View reviewed changes

Rahmeen14 force-pushed the mybranch branch from fead2f5 to 5ab3f3f Compare January 16, 2018 15:59

gitmate-bot added process/approved and removed process/pending review labels Jan 16, 2018

jayvdb approved these changes Mar 10, 2018

View reviewed changes

gitmate-bot force-pushed the mybranch branch from 5ab3f3f to f446b98 Compare March 10, 2018 03:32

gitmate-bot added process/pending review process/approved and removed process/approved process/pending review labels Mar 10, 2018

gitmate-bot merged commit f446b98 into coala:master Mar 10, 2018

gitmate-bot added process/approved and removed process/approved labels Mar 10, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tutorial.rst: Change documentation about .coafile #510

Tutorial.rst: Change documentation about .coafile #510

Rahmeen14 commented Dec 16, 2017 •

edited

Loading

Rahmeen14 commented Dec 16, 2017

ishanSrt left a comment

ishanSrt commented Dec 17, 2017

ishanSrt commented Dec 17, 2017

ishanSrt commented Dec 17, 2017 •

edited

Loading

Rahmeen14 commented Dec 17, 2017

ishanSrt commented Dec 17, 2017 •

edited

Loading

RaiVaibhav left a comment •

edited

Loading

RaiVaibhav commented Dec 17, 2017

Rahmeen14 commented Dec 17, 2017 •

edited

Loading

RaiVaibhav commented Dec 17, 2017

Rahmeen14 commented Dec 17, 2017

Rahmeen14 commented Dec 17, 2017

ishanSrt commented Dec 17, 2017

ishanSrt commented Dec 17, 2017 •

edited

Loading

Rahmeen14 commented Dec 17, 2017

Makman2 commented Jan 15, 2018 •

edited

Loading

Makman2 commented Jan 15, 2018

Rahmeen14 commented Jan 16, 2018

ishanSrt left a comment •

edited

Loading

Rahmeen14 commented Jan 16, 2018

ishanSrt commented Jan 16, 2018

Makman2 commented Jan 16, 2018

jayvdb commented Mar 10, 2018

gitmate-bot commented Mar 10, 2018

gitmate-bot commented Mar 10, 2018

jayvdb commented Mar 10, 2018

gitmate-bot commented Mar 10, 2018

gitmate-bot commented Mar 10, 2018

Tutorial.rst: Change documentation about .coafile #510

Tutorial.rst: Change documentation about .coafile #510

Conversation

Rahmeen14 commented Dec 16, 2017 • edited Loading

Checklist

Rahmeen14 commented Dec 16, 2017

ishanSrt left a comment

Choose a reason for hiding this comment

ishanSrt commented Dec 17, 2017

ishanSrt commented Dec 17, 2017

ishanSrt commented Dec 17, 2017 • edited Loading

Rahmeen14 commented Dec 17, 2017

ishanSrt commented Dec 17, 2017 • edited Loading

RaiVaibhav left a comment • edited Loading

Choose a reason for hiding this comment

RaiVaibhav commented Dec 17, 2017

Rahmeen14 commented Dec 17, 2017 • edited Loading

RaiVaibhav commented Dec 17, 2017

Rahmeen14 commented Dec 17, 2017

Rahmeen14 commented Dec 17, 2017

ishanSrt commented Dec 17, 2017

ishanSrt commented Dec 17, 2017 • edited Loading

Rahmeen14 commented Dec 17, 2017

Makman2 commented Jan 15, 2018 • edited Loading

Makman2 commented Jan 15, 2018

Rahmeen14 commented Jan 16, 2018

ishanSrt left a comment • edited Loading

Choose a reason for hiding this comment

Rahmeen14 commented Jan 16, 2018

ishanSrt commented Jan 16, 2018

Makman2 commented Jan 16, 2018

jayvdb commented Mar 10, 2018

gitmate-bot commented Mar 10, 2018

gitmate-bot commented Mar 10, 2018

jayvdb commented Mar 10, 2018

gitmate-bot commented Mar 10, 2018

gitmate-bot commented Mar 10, 2018

Rahmeen14 commented Dec 16, 2017 •

edited

Loading

ishanSrt commented Dec 17, 2017 •

edited

Loading

ishanSrt commented Dec 17, 2017 •

edited

Loading

RaiVaibhav left a comment •

edited

Loading

Rahmeen14 commented Dec 17, 2017 •

edited

Loading

ishanSrt commented Dec 17, 2017 •

edited

Loading

Makman2 commented Jan 15, 2018 •

edited

Loading

ishanSrt left a comment •

edited

Loading