Comments (5)
(by mwhudson)
I think I generally agree, although there probably should be a limit of say three lines so that the summary doesn't get out of hand when people fail to follow the rules and start the docstring with a summary.
This shouldn't be hard, feel like writing a patch?
from pydoctor.
(by hyneks)
Sure. I'll look at it as soon as I get to my office.
from pydoctor.
(by hyneks)
I checked in a fix at http://bazaar.launchpad.net/~hyneks/pydoctor/summary-fix/revision/573 - let me know what you think.
I'm not sure what to make of pydoctor/html.py -- is that used somewhere?
(My first launchpad interaction, let me know if I'm doing something stupid.)
from pydoctor.
(by mwhudson)
html.py is mostly a relic of the formatter that existed before the nevow one (which should be redone to use twisted.web.template I guess) was written.
As to the branch, I wouldn't have used itertools so much but it works so I'll merge it :)
As to how to use launchpad, you seem to be doing fine! You could have used 'propose for merging' on your branch, but linking it from the bug report is good too.
from pydoctor.
(by hyneks)
Usually, I'm not much of an itertools snob neither, however this saved me two for loops and gave superior legibility so I just went for it. :)
I'm glad you like it, let me know if I can give you hand with something as long as I'm on a roll. ;)
from pydoctor.
Related Issues (20)
- Is this normal? HOT 3
- Be clear that exit code 2 means partial success HOT 3
- Intersphinx from local folder HOT 6
- Fix verbose mode
- Regression on in link not found warnings linenumbers
- ERROR collecting pydoctor/test/test_attrs.py with Python-3.12 HOT 3
- Including default values for Pydantic model attributes HOT 3
- Don't raise exceptions when offline HOT 1
- dev-doc: "pydoctor_primer" not documented HOT 6
- Missing test dependencies: hypothesis HOT 4
- Failing and undocumented test "test_pyval_repr.py::test_expressions_parens" HOT 3
- "tox -p all" not working HOT 3
- "tox -p all" to noise for extern contributors HOT 4
- Contribution docu: Code Style HOT 1
- Test docu: Missing docu about test_packags.py and processPackage()
- Build infrastructure: Run ReadTheDocs on every PR/commit? HOT 2
- Find an extensible manner to integrate templatewriter customizations
- How to break down (debug) " Cannot find link target for XYZ" errors? HOT 9
- Failure to process classifiers as part of consolidation fields in a reStructuredText docstring HOT 2
- Upgrade all annotations to use python 3.10 style HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pydoctor.