Review Request 122462: [KCompletion] Fix typos in documentation

[Dominik Haumann]

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


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 :-)


src/kcombobox.h
<https://git.reviewboard.kde.org/r/122462/#comment52276>

    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).



src/kcombobox.h
<https://git.reviewboard.kde.org/r/122462/#comment52277>

    Doxygen is fine with these two spaces as well... (everywhere).


- Dominik Haumann


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/20150207/e23c1fff/attachment.html>