Added clarity and simplified sentences. Added minor stylistic arrangement.
Diff Detail
Diff Detail
- Repository
- R985 KDE Human Interface Guidelines
- Branch
- arcpatch-D15396
- Lint
No Linters Available - Unit
No Unit Test Coverage - Build Status
Buildable 2911 Build 2929: arc lint + arc unit
| source/introduction/research.rst | ||
|---|---|---|
| 4–5 | With these changes, the first comma now needs to be replaced with a colon; otherwise, the next two clauses are sentence fragments. | |
| 17 | Do we really want to capitalize this? I'm not sure. If we do, you need to capitalize it elsewhere too. Doesn't really seem worth it, IMHO. | |
| 21 | Un-capitalize "User" | |
| 27–30 | Please add a manual line break after "can" to preserve the formatting. We do manual line breaks before character 80 for the HIG's text. | |
| 28 | in which -> within which | |
| 40–41 | Add one more "-" so it's under the new question mark | |
| 43–44 | "Detail major tasks and specialty" Hmm, not really sure what this means. Maybe re-phrase. | |
| 44 | planned functionality -> functionality that's planned | |
| 48–49 | Add one more "~" | |
| 58 | Add manual line breaks for this line | |
| 58–59 | Needs moar "~"! | |
| 71–72 | add some more "-" | |
| source/introduction/research.rst | ||
|---|---|---|
| 17 | I capitalized it because it was a subheading, not because I meant to capitalize Applications. Does it hold up? Should it be changed? | |
| 43–44 | I turned it into "Detail major tasks and specialty tasks" but I don't really know what specialty tasks are. Maybe @colomar may know? | |
| 48–49 | I am going to ignore these ones because they don't make a difference for the markup. When it is rendered, the system knows that the lines will cover the entire line of text. | |
| source/introduction/research.rst | ||
|---|---|---|
| 4–5 | It makes no difference. In fact, it seems that a semicolon is more common. A period is actually more common than colon and semicolon. https://writingcenter.unc.edu/tips-and-tools/semi-colons-colons-and-dashes/ What should we stick to? | |
| source/introduction/research.rst | ||
|---|---|---|
| 4–5 | It does make a difference, because they do different things. In this case, if we use a colon, that implies that "who it is for, and what people can do with it" is an example of the short summary of the purpose of the app. Dashes could work here too. But when it's a semicolon, the concepts are more disconnected from one another. | |
Comment Actions
This doesn't merge cleanly. Looks like someone has changed source/introduction/research.rst since you submitted this patch, or else your local checkout wasn't up-to-date when you created your branch. You need to re-base on current master. Do git pull --rebase origin master and follow the instructions. I can help you over chat if needed.
Also, it looks like you do need to add enough tildes or dashes underneath titles, or else sphinx complains about it:
/home/nate/KDE/hig-kde-org/source/introduction/research.rst:55: WARNING: Title underline too short. (What kinds of functionality will the application *not* support?) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Comment Actions
I did git pull --rebase origin master and now it won't let me push the changes to this document. It complaints that the revision for the images for the previous HIG that I worked on is now closed. Not sure what to do there. I guess I won't be able to correct anything and need to start again.
Comment Actions
Did you verify that you were on the right branch? Afterwards, just do an arc diff to update the patch; I don't think you actually have push rights for this repo yet.
Comment Actions
This stuff is all done on https://invent.kde.org/websites/hig-kde-org/ now. Can you move it over there if it's still relevant?