Re: [Wikitech-l] use of @inheritdoc

[Legoktm]

Hi,

On 05/13/2017 03:43 PM, Ryan Kaldari wrote:
> A question that came up during Documentation Day was whether or not we
> should use the @inheritdoc convention for indicating that methods are
> documented in parent classes (rather than leaving them blank).
> 
> Some arguments for using it include:
> * It can help code-sniffers and linters know that the documentation isn't
> missing.
> * It lets humans who are looking at the code know that they can find
> documentation elsewhere.
> * We are already using it. (It appears over 200 times in core JavaScript
> and about 40 times in core PHP. It's also used in at least 19 production
> extensions.)
> 
> Some arguments for not using it:
> * It isn't necessary for generating docs at doc.wikimedia.org (Doxygen
> automatically inherits method docs if available).
> * It would require adding thousands of extra comment blocks to our code to
> implement it consistently.
> 
> What are people's opinions on using it?

I think the pros you mentioned outweigh the cons. I currently have a
patch[1] for MW-Codesniffer to recognize methods with "@inheritDoc" (but
not when surrounded by braces) as documented and not flag them.

[1] https://gerrit.wikimedia.org/r/#/c/353623/

-- Kunal

___
Wikitech-l mailing list
Wikitech-l@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikitech-l

[Wikitech-l] RevisionSlider will become a default feature tomorrow

[Lea Voget]

- my apologies for cross-posting -

Hey all,

tomorrow the RevisionSlider [1] will be available as a default feature for
all users on all wikis. The RevisionSlider adds a slider view to the diff
page so that you can easily move between revisions. The slider view is
collapsed by default, and will load by clicking on it. It can also be
turned off entirely in the user preferences. The RevisionSlider has been a
default feature on German, Arabic and Hebrew Wikipedia for 6 months and a
beta feature on all wikis for 8 months. In addition to the users of the
default feature, the extension is used by more than 38K beta feature users
[2] and we have spent the past months addressing the issues raised.

The feature fulfills a wish from the German Community’s Technical Wishlist
[3], is inspired by DerHexer's revisionjumper gadget [4] and based on a
prototype by
the WMF's Community Tech Team
 [5].

Thanks to everyone who tested RevisionSlider and gave valuable feedback to
improve the feature! We hope that RevisionSlider will continue to serve all
contributors well.


Lea (for WMDE's Technical Wishes team)


[1] https://www.mediawiki.org/wiki/Extension:RevisionSlider

[2]  https://grafana.wikimedia.org/dashboard/db/mediawiki-revisionslider

[3]  https://meta.wikimedia.org/wiki/WMDE_Technical_Wishes

[4] https://en.wikipedia.org/wiki/User:DerHexer/revisionjumper

[5] https://meta.wikimedia.org/wiki/Community_Tech/RevisionSlider



-- 
Lea Voget
Product Manager Technical Wishlist
Produktmanager Technische Wunschliste

Wikimedia Deutschland e. V. | Tempelhofer Ufer 23-24 | 10963 Berlin
Tel. (030) 219 158 26-0
http://wikimedia.de

Stellen Sie sich eine Welt vor, in der jeder Mensch an der Menge allen
Wissens frei teilhaben kann. Helfen Sie uns dabei!
http://spenden.wikimedia.de/

Wikimedia Deutschland - Gesellschaft zur Förderung Freien Wissens e. V.
Eingetragen im Vereinsregister des Amtsgerichts Berlin-Charlottenburg unter
der Nummer 23855 B. Als gemeinnützig anerkannt durch das Finanzamt für
Körperschaften I Berlin, Steuernummer 27/029/42207.
___
Wikitech-l mailing list
Wikitech-l@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikitech-l

Re: [Wikitech-l] Congratulations to accepted candidates for Google Summer of Code 2017 & Outreachy Round 14

[Keerthana S]

I am Keerthana from India, pursuing B.Tech in Engineering Physics from IIT
Madras. I am gonna be working on Wiki Edu dashboard by WikiEducation
Foundation. My project during the summer will be to add a feature to give
some automatic feedback on the articles being edited by the dashboard users
using the ML based data on the articles. This can especially help beginner
Wikipedia editors to have not so bad experience on their first Wikipedia
article. And using the same data it is possible to build a feature that can
help editors find an article to which they can contribute the best to based
on their previous Wikipedia editing experience. My mentors for the project
are Sage Ross and Jonathan Morgan
On Sun, May 7, 2017, 7:10 PM Sonali Gupta  wrote:

> Hello,
>
> I am Sonali Gupta. I am from India, currently pursuing a bachelor's
> degree in Computer Science. I will be graduating in May, 2018.
> I am immensely happy to be a part of Wikimedia community as an Outreachy
> intern. I will be writing documentation on how to create a Zotero
> translator. These translators are used by Citoid, a service to generate
> citation data. By the end of this project, I hope everyone will find it
> easy to write translators for the sites they wish, by making use of the
> documentation that will be prepared. It will be available on
> https://www.mediawiki.org/wiki/Citoid/Creating_Zotero_translators
> I am super excited to work and learn new stuff this summer. I want to
> especially thank Marielle Volz and Srishti Sethi for giving me this
> opportunity and putting faith in me. I hope to be an asset to the team.
>
>
> ___
> Wikitech-l mailing list
> Wikitech-l@lists.wikimedia.org
> https://lists.wikimedia.org/mailman/listinfo/wikitech-l
___
Wikitech-l mailing list
Wikitech-l@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/wikitech-l