Review Request 115206: Correct spelling, grammar and style of kcompletion.h docs

[Alex Merry]

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


Thanks for working on apidox!  Sorry for the large number of comments...


src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33955>

    I would reword this more drastically to "manual completion works the same way as auto completion, except that it is not invoked automatically while the user..."



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33956>

    I would rephrase this as "shell completion works like "tab completion" in a shell:"



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33957>

    "As an application programmer, you do not normally have to worry about the different completion modes; KCompletion handles..."



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33958>

    You remove the hyphen from "auto-completion" ealier, but not here.



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33959>

    "but this is usually not necessary."



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33960>

    except -> but



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33961>

    hyphens again (consistency)



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33962>

    I think the original wording is better.



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33963>

    "list of matching items"



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33964>

    A sound is not normally "issued".  Maybe "emitted"?  There are similar occurrence of this in other places.



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33965>

    Comments from previousMatch apply



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33967>

    I would just say "Sets the completion mode."
    
    Possible "active completion mode"?  If so, the docs for completionMode() should change to match.



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33966>

    @see CompletionMode
    (capitalisation)



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33968>

    Remove comma before if



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33969>

    LOTS -> a @em lot



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33970>

    LOTS -> a @em lot



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33971>

    This change is not just a style change; it changes the meaning.  Are you sure this is correct?



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33972>

    remove "in order"



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33973>

    Huh, we should probably just make the other methods slots, and deprecate the ones prefixed with "slot".  Well, out of scope for this RR.



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33974>

    One sentence: "This signal is emitted by makeCompletion() when a match is found.



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33975>

    hyphens



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33976>

    "twice or more" -> "multiple times in a row" (which is I think what is intended).
    
    Also "It sends all matching items" is probably some description that belongs in the @param matchlist



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33977>

    What are these #s supposed to be?



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33978>

    Like above, you are changing the meaning.  Is it correct?



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33979>

    Duplication of the CompletionMode docs?  I would just put an @see in.



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33980>

    "for another feature"



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33981>

    "there is"



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33982>

    won't -> will not



src/kcompletion.h
<https://git.reviewboard.kde.org/r/115206/#comment33983>

    "except that it"


- Alex Merry


On Jan. 21, 2014, 11:12 p.m., David Gil Oliva wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/115206/
> -----------------------------------------------------------
> 
> (Updated Jan. 21, 2014, 11:12 p.m.)
> 
> 
> Review request for KDE Frameworks.
> 
> 
> Repository: kcompletion
> 
> 
> Description
> -------
> 
> Correct spelling, grammar and style of kcompletion.h docs
> 
> 
> Diffs
> -----
> 
>   src/kcompletion.h 46b63a4 
> 
> Diff: https://git.reviewboard.kde.org/r/115206/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> David Gil Oliva
> 
>

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