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

Clean up docs args #424

Closed
wants to merge 2 commits into from
Closed

Conversation

rgriff23
Copy link
Contributor

Minor fixes for #269:

  • Bloomerang: rm some extraneous backticks from args in docstrings
  • Twilio: escape hyperlink formatting using backslash in the from_ arg

@rgriff23
Copy link
Contributor Author

@shaunagm hmmm I thought this backslash would work to escape the hyperlink formatting based on reading this:

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#escaping-mechanism

I also got an answer on Stack Overflow which told me it would work.

@shaunagm
Copy link
Collaborator

shaunagm commented Oct 1, 2020

Looks good to me:

twilio

FYI if you're having trouble building the docs yourself, there are some proto-instructions here. (I'll be tackling the issue itself tomorrow with a new Parsons contributor.)

@shaunagm
Copy link
Collaborator

shaunagm commented Oct 1, 2020

Oh it looks like your change causes a linting error:

Screenshot from 2020-10-01 10-00-06

My inclination is to ignore the linting error but we can see what Eliot says.

@shaunagm shaunagm added the ragtag label Oct 1, 2020
@rgriff23 rgriff23 closed this Oct 6, 2020
@rgriff23 rgriff23 deleted the clean_up_docs_args branch October 6, 2020 11:41
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.

2 participants