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

re-wrap some docstrings that are mis-formatted or too long #83

Merged
merged 4 commits into from
Jan 16, 2017

Conversation

glyph
Copy link
Member

@glyph glyph commented Sep 12, 2016

eimaginary and objects included.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 93.05% when pulling aa50e05 on glyph:docstrings into 9886934 on twisted:master.

@@ -35,7 +35,7 @@
"Topic :: Terminals"],
packages=find_packages() + ['axiom.plugins', 'xmantissa.plugins'],
install_requires=[
"twisted>=14.0.0",
"twisted>=14.0.0,<16.4.0",
Copy link
Member

@ashfall ashfall Oct 14, 2016

Choose a reason for hiding this comment

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

oh? Out of curiosity, what did 16.4 break?

Copy link
Contributor

Choose a reason for hiding this comment

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

It might be http://twistedmatrix.com/trac/ticket/8843? In any case, there should be a comment explaining the issue as best it is understood (ideally linking to a ticket, but even just the comment from the commit would be sufficient).

Copy link
Member Author

Choose a reason for hiding this comment

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

Yep. I put a comment on there. Instead of adding a version constraint, I'm just adding a workaround and linking to the issue.


@ivar action: The action which was being processed when an ambiguity was
found.
found.
Copy link
Member

Choose a reason for hiding this comment

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

Looks like this is missing a @type.

Copy link
Contributor

Choose a reason for hiding this comment

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

While it should perhaps have a @type, I don't think that this should block this PR.

@tomprince
Copy link
Contributor

Please merge after adding some reasoning behind the twisted version cap.

add a workaround instead
@glyph glyph merged commit e84abc9 into twisted:master Jan 16, 2017
@glyph glyph deleted the docstrings branch January 16, 2017 01:07
@glyph
Copy link
Member Author

glyph commented Jan 16, 2017

Thanks @tomprince for the review!

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.

None yet

4 participants