https://bugzilla.wikimedia.org/show_bug.cgi?id=34965

       Web browser: ---
             Bug #: 34965
           Summary: Clean up grammar in ApiSandbox "Documentation" section
           Product: MediaWiki extensions
           Version: any
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: Unprioritized
         Component: ApiSandbox
        AssignedTo: wikibugs-l@lists.wikimedia.org
        ReportedBy: b...@mzmcbride.com
                CC: maxsem.w...@gmail.com, s...@reedyboy.net
    Classification: Unclassified
   Mobile Platform: ---


I'm not sure where the "Documentation" section of ApiSandbox comes from, but it
currently has inconsistent (and, in some cases, wrong) grammar.

Examples:

list=exturlusage --> euquery --> "Protocol of the url. If empty and euquery
set, the protocol is http. 
Leave both this and euquery empty to list all external links"

"URL" should be capitalized.

action=clicktracking --> "Track user clicks on JavaScript items."

Ends in a period?

action=coderevisionupdate --> "Submit comments, new status and tags to a
revision"

No final period?

action=wikiloveimagelog --> "This API is for logging each time a user attempts
to use a custom image via WikiLove."

"This API"? This isn't consistent language with the documentation for the rest
of the parameters. And it ends in a period.

These are just a few examples. Consistent style should be applied throughout.
If the text is going to end in periods, it should end in periods every time. If
"URL" is going to be capitalized (when used in documentation text), it should
be consistently capitalized. Etc.

-- 
Configure bugmail: https://bugzilla.wikimedia.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
You are on the CC list for the bug.

_______________________________________________
Wikibugs-l mailing list
Wikibugs-l@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikibugs-l

Reply via email to