Opened 17 years ago
Closed 17 years ago
#4658 closed (fixed)
documentation of linebreaks filter is too vague
| Reported by: | Owned by: | nobody | |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Keywords: | sprintsept14 | |
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | yes |
| Easy pickings: | no | UI/UX: | no |
Description
Currently it reads: Converts newlines into <p> and <br /> tags.
It should be something more like: Converts newlines to <br /> tags and wraps the resulting string in a <p> tag.
Note: the docstring of this filter's Python function is also vague and also should be changed.
Attachments (2)
Change History (9)
comment:1 by , 17 years ago
| Triage Stage: | Unreviewed → Ready for checkin |
|---|
follow-up: 3 comment:2 by , 17 years ago
| Needs documentation: | set |
|---|---|
| Triage Stage: | Ready for checkin → Accepted |
comment:3 by , 17 years ago
Replying to SmileyChris:
It doesn't just wrap the whole string in one <p>, it breaks multi-newlines into <p>s
Now that was a case that I did not try. Good thing we are fixing the documentation :)
How about we stick an example in there.
comment:4 by , 17 years ago
| Has patch: | set |
|---|---|
| Needs documentation: | unset |
comment:5 by , 17 years ago
| Patch needs improvement: | set |
|---|
I think the wording could still be improved, and I forgot to change the docstring.
by , 17 years ago
| Attachment: | linebreaks.diff added |
|---|
comment:6 by , 17 years ago
| Keywords: | sprintsept14 added |
|---|---|
| Triage Stage: | Accepted → Ready for checkin |
Added a patch with hopefully clearer documentation for both linebreaks and linebreaksbr, as well as updated docstrings to match.
comment:7 by , 17 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
Your suggestion is no more clearer. It doesn't just wrap the whole string in one <p>, it breaks multi-newlines into <p>s