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.

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

Tutorial for writing bear actions #4

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Conversation

akshatkarani
Copy link
Owner

This adds a tutorial which describes how to write
actions specific to bears.

Copy link

@abhishalya abhishalya left a comment

Choose a reason for hiding this comment

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

Looks good overall, here are some suggested changes.

docs/Developers/Writing_bear_actions.rst Outdated Show resolved Hide resolved
docs/Developers/Writing_bear_actions.rst Outdated Show resolved Hide resolved
docs/Developers/Writing_bear_actions.rst Outdated Show resolved Hide resolved
docs/Developers/Writing_bear_actions.rst Outdated Show resolved Hide resolved
docs/Developers/Writing_bear_actions.rst Outdated Show resolved Hide resolved
docs/Developers/Writing_bear_actions.rst Outdated Show resolved Hide resolved
docs/Developers/Writing_bear_actions.rst Outdated Show resolved Hide resolved
- ``DoNothingAction``: As the name suggests this action does nothing, you can
choose this action when you want to ignore the result.
- ``ShowPatchAction``: This action displays the changes in code suggested by
coala.

Choose a reason for hiding this comment

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

bear should be the one suggesting imo

docs/Developers/Writing_bear_actions.rst Outdated Show resolved Hide resolved

def run():

yield Result(.., actions=[SomeAction()]) # Ignore RSTcheckBear

Choose a reason for hiding this comment

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

RSTcheckBear having some issues with this line?

Copy link
Owner Author

Choose a reason for hiding this comment

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

Yes, it is complaining about invalid syntax, it is because of ..

Choose a reason for hiding this comment

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

Maybe then you shouldn't ignore, complete the syntax.

@abhishalya
Copy link

You can create this PR in the main coala repo now.

@akshatkarani akshatkarani force-pushed the bear-actions-tut branch 8 times, most recently from fcebd42 to b9d72b0 Compare August 10, 2019 04:35
abhishalya and others added 3 commits May 2, 2020 18:35
This adds a tutorial in the docs which describes how to write
actions specific to bears.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants