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

Docs tweaks and a squashed bug #225

Merged
merged 3 commits into from
Sep 26, 2018
Merged

Conversation

cicdw
Copy link
Member

@cicdw cicdw commented Sep 26, 2018

Closes #155

  • Removed some redundant class headers
  • added some flair to all signatures (including classes) + some indentation for multi-line signatures
  • fixed some minor bugs I had been noticing that bothered me

Check out the netlify deploy build to see it in action!

@cicdw cicdw requested a review from jlowin as a code owner September 26, 2018 00:13
has been exceeded </li>
<li> `SKIP` will skip the task and possibly propogate the skip state through the
flow, depending on whether downstream tasks have `skip_on_upstream_skip=True`. </li></ul>
</li></ul>
Copy link
Member Author

Choose a reason for hiding this comment

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

Ok so this is up for debate; I put HTML directly into the docstring here so the list would format inside the table. I'm happy to remove this change though if we don't think it's appropriate.

Copy link
Member

Choose a reason for hiding this comment

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

In this particular case I think it's appropriate to favor the docs because it's such an important method, and if that means HTML I'm all for it.

Copy link
Member Author

Choose a reason for hiding this comment

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

That was my thought too, awesome

has been exceeded </li>
<li> `SKIP` will skip the task and possibly propogate the skip state through the
flow, depending on whether downstream tasks have `skip_on_upstream_skip=True`. </li></ul>
</li></ul>
Copy link
Member

Choose a reason for hiding this comment

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

In this particular case I think it's appropriate to favor the docs because it's such an important method, and if that means HTML I'm all for it.

@cicdw cicdw merged commit 54704f6 into master Sep 26, 2018
@cicdw cicdw deleted the docs-tweaks-and-a-squashed-bug branch September 26, 2018 01:14
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.

Doc markdown formatting tweaks
2 participants