Review Request 122462: [KCompletion] Fix typos in documentation

Sun Feb 8 22:44:16 UTC 2015

> On feb. 7, 2015, 7:14 p.m., Dominik Haumann wrote:
> > Using two spaces is called "sentence spacing" and most probably done by intention, see http://en.wikipedia.org/wiki/Sentence_spacing
> > So this is a matter of taste, and should not be changed especially in the licensing headers. KDE typically use the license headers from the GNU homepage, and there the two spaces are also used. (In fact, there are git hooks that make sure you add a license to your code if you add a file in git. Changing unnecessarily the header might even break such commit hooks.)
> > 
> > In this patch, I think changing "re-implemented" to "reimplemented" is what can be committed, but please update the review request for that first :-)
> > 
> > You can have a look at the generated doxygen output at e.g. http://api.kde.org/frameworks-api/frameworks5-apidocs/kcompletion/html/classKComboBox.html#ae14aa07f44ab4ef1767586afe592155c
> > As you can see, the two spaces are folded into just one space by doxygen.
> > 
> > If you fix doxygen comments, please do it based on the resulting output on api.kde.org :-)

Hi!

"Using two spaces is called "sentence spacing" and most probably done by intention, see http://en.wikipedia.org/wiki/Sentence_spacing"

I know what's "sentence spacing". I spent five years at University studying Translation (German, English, Catalan and Spanish, and I speak Dutch and learned some Basque). At the time, languages were my life. Now I prefer computers.

"In this patch, I think changing "re-implemented" to "reimplemented" is what can be committed,"

Only that? What about the other changes?

"You can have a look at the generated doxygen output at e.g. http://api.kde.org/frameworks-api/frameworks5-apidocs/kcompletion/html/classKComboBox.html#ae14aa07f44ab4ef1767586afe592155c
As you can see, the two spaces are folded into just one space by doxygen.

If you fix doxygen comments, please do it based on the resulting output on api.kde.org :-)"

You say that as if only output mattered and doxygen comments weren't read and couldn't be changed. I read doxygen comments far more often than the output in api.kde.org.

> On feb. 7, 2015, 7:14 p.m., Dominik Haumann wrote:
> > src/kcombobox.h, line 13
> > <https://git.reviewboard.kde.org/r/122462/diff/1/?file=347378#file347378line13>
> >
> >     Please do not change the two spaces to a single one, especially not in the license (we might have scripts parsing the headers for licenses, and we should not change the license from what you can find on the gnu homepage).

I agree on this one, but more for a technical reason than a linguistic one.

> On feb. 7, 2015, 7:14 p.m., Dominik Haumann wrote:
> > src/kcombobox.h, line 60
> > <https://git.reviewboard.kde.org/r/122462/diff/1/?file=347378#file347378line60>
> >
> >     Doxygen is fine with these two spaces as well... (everywhere).

Let's see, that doxygen converts the two spaces into one makes me think that it's ok to have one also in doxygen comments.

Moreover, if it was a matter of taste (which I kind of doubt) then it would be great, because I'm the maintainer of the framework and I hate double spacing.

If it was a matter of taste, again, then I have a powerful reason to kill the double spacing. There's a second thing we translators hate most (first one is typos and bad grammar) and it is when texts are not coherent. If you read all the doxygen comments in KCompletion, you'll find double spacing mixed with single spacing, and that's awful. 

Finally, I'm more on the double-spacing-is-not-needed-anymore side :-) : http://www.slate.com/articles/technology/technology/2011/01/space_invaders.html

- David

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/122462/#review75573
-----------------------------------------------------------

On feb. 6, 2015, 11:03 p.m., David Gil Oliva wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/122462/
> -----------------------------------------------------------
> 
> (Updated feb. 6, 2015, 11:03 p.m.)
> 
> 
> Review request for KDE Frameworks.
> 
> 
> Repository: kcompletion
> 
> 
> Description
> -------
> 
> Fix typos in documentation
> 
> - Substitute double space after period for single space
> - emition --> emission
> - Re-implemented --> Reimplemented
> 
> 
> Diffs
> -----
> 
>   src/kcombobox.h 075d42f 
>   src/kcompletion.h a6ed372 
>   src/kcompletion_p.h 138c228 
>   src/kcompletionbase.h 6111f9a 
>   src/kcompletionbox.h 1759eba 
>   src/kcompletionmatches.h 517f111 
>   src/khistorycombobox.h 182ba0a 
>   src/klineedit.h 460a2ae 
>   src/klineedit_p.h 0be32ba 
>   src/kpixmapprovider.h 67917f2 
>   src/ksortablelist.h 8b1b155 
>   src/kzoneallocator_p.h 2d75a83 
> 
> Diff: https://git.reviewboard.kde.org/r/122462/diff/
> 
> 
> Testing
> -------
> 
> None needed
> 
> 
> Thanks,
> 
> David Gil Oliva
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20150208/7e7b30cb/attachment-0001.html>