Opened 5 years ago
Closed 5 years ago
#5555 enhancement closed fixed (fixed)
Fix epytext markup issues in twisted.words.xish
| Reported by: | Liz | Owned by: | ralphm |
|---|---|---|---|
| Priority: | normal | Milestone: | |
| Component: | words | Keywords: | |
| Cc: | ralphm, jesstess | Branch: |
branches/xish-epytext-5555
branch-diff, diff-cov, branch-cov, buildbot |
| Author: | ralphm |
Description
We have a ton of invalid epytext that produces warnings like shown in http://pastebin.com/Hd7F0Z0G when we generate the docs.
Change History (10)
comment:1 Changed 5 years ago by
| Cc: | ralphm added |
|---|
comment:2 Changed 5 years ago by
| Cc: | jesstess added |
|---|
comment:3 Changed 5 years ago by
| Author: | → ralphm |
|---|---|
| Branch: | → branches/xish-epytext-5555 |
comment:4 follow-up: 8 Changed 5 years ago by
| Owner: | changed from Liz to ralphm |
|---|---|
| Status: | new → assigned |
Apologies for taking over this ticket. I wasn't aware that it was meant as a way to give our new contributors some easy tickets.
I removed the references to build-in types like str, unicode, etc., and to external modules.
I left the other warnings for what they are. Apparently, there are quite some issues with the object resolution within Pydoctor itself:
- Links to (local and external) module attributes are not resolved.
- In some cases, two modules documenting things that are in the other module, don't get resolved.
- Local class attributes sometimes don't resolve (like
logTrafficinStreamManager).
comment:5 Changed 5 years ago by
| Keywords: | review added |
|---|---|
| Owner: | ralphm deleted |
| Status: | assigned → new |
I think this should be ready now. Please review.
comment:8 follow-up: 9 Changed 5 years ago by
| Keywords: | review removed |
|---|---|
| Owner: | set to ralphm |
Replying to ralphm:
Apologies for taking over this ticket. I wasn't aware that it was meant as a way to give our new contributors some easy tickets.
I removed the references to build-in types like
str,unicode, etc., and to external modules.I left the other warnings for what they are. Apparently, there are quite some issues with the object resolution within Pydoctor itself:
- Links to (local and external) module attributes are not resolved.
- In some cases, two modules documenting things that are in the other module, don't get resolved.
- Local class attributes sometimes don't resolve (like
logTrafficinStreamManager).
Thanks for fixing those. Could you also fix the other coding standard stuff like putting docstrings on 3 lines (without the current prefixing whitespace):
""" Generic Streaming XML protocol handler.
The news file can be an empty .misc file, I doubt users will care we fixed an api doc issue (cause there are many).
comment:9 Changed 5 years ago by
| Status: | new → assigned |
|---|
Replying to thijs:
It is better to do these changes as part of another ticket, as exarkun rightly mentioned in #twisted.
The news file can be an empty .misc file, I doubt users will care we fixed an api doc issue (cause there are many).
Fixed.
comment:10 Changed 5 years ago by
| Resolution: | → fixed |
|---|---|
| Status: | assigned → closed |
(In [33867]) Branching to 'xish-epytext-5555'