Change Details

All libraries that need documentation can be found at https://github.com/addwiki Each of the libraries documentation is stored in the library repo within the 'docs' directory. The documentation is written using the RST markup. An example commit introducing documentation for a single feature of one of the libraries can be found at https://github.com/addwiki/mediawiki-api/commit/b17ffb5b3294a0566afa6f0e4a07243fcb3c1529#diff-e3e2a9bfd88566b05001b02a3f51d286 **NOTE: The example commit includes an error, and these services should not be constructed directly but instead retreived from the relevant factory https://github.com/addwiki/mediawiki-api/blob/b17ffb5b3294a0566afa6f0e4a07243fcb3c1529/src/MediawikiFactory.php#L125** Features that need documentation can be found in the lists below: - https://github.com/addwiki/mediawiki-datamodel (14 tasks) [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Content.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/EditInfo.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/File.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Log.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/LogList.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/NamespaceInfo.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Page.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/PageIdentifier.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Pages.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Redirect.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Revision.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Revisions.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Title.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/User.php - https://github.com/addwiki/mediawiki-api (21 tasks) [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/FileUploader.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/ImageRotator.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/LogListGetter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageDeleter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageListGetter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageMover.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageProtector.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PagePurger.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageRestorer.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageWatcher.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/Parser.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionDeleter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionPatroller.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionRestorer.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionRollbacker.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionSaver.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionUndoer.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/UserBlocker.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/UserCreator.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/UserGetter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/UserRightsChanger.php - https://github.com/addwiki/wikibase-api (25 tasks) [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/EntityApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/EntityRedirectApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/ItemApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/PropertyApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/TermApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/AliasGroupSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/BadgeIdsGetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/DescriptionSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/EntityDocumentSaver.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ItemMerger.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/LabelSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/RedirectCreator.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ReferenceRemover.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ReferenceSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/RevisionGetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/RevisionSaver.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/RevisionsGetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/SiteLinkLinker.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/SiteLinkSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/StatementCreator.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/StatementGetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/StatementRemover.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/StatementSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ValueFormatter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ValueParser.php For Google-Code-In it may make sense to have a single task for each feature in need of documentation.

All libraries that need documentation can be found at https://github.com/addwiki . Each of the libraries documentation is stored in the library repo within the `docs` directory. The documentation is written using the RST markup. An example commit introducing documentation for a single feature of one of the libraries can be [found here](https://github.com/addwiki/mediawiki-api/commit/b17ffb5b3294a0566afa6f0e4a07243fcb3c1529#diff-e3e2a9bfd88566b05001b02a3f51d286) but note that the example commit includes an error, and [these services should not be constructed directly but instead retreived from the relevant factory](https://github.com/addwiki/mediawiki-api/blob/b17ffb5b3294a0566afa6f0e4a07243fcb3c1529/src/MediawikiFactory.php#L125). Features that need documentation can be found in the lists below: - https://github.com/addwiki/mediawiki-datamodel (14 tasks) [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Content.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/EditInfo.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/File.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Log.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/LogList.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/NamespaceInfo.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Page.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/PageIdentifier.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Pages.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Redirect.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Revision.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Revisions.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Title.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/User.php - https://github.com/addwiki/mediawiki-api (21 tasks) [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/FileUploader.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/ImageRotator.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/LogListGetter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageDeleter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageListGetter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageMover.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageProtector.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PagePurger.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageRestorer.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageWatcher.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/Parser.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionDeleter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionPatroller.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionRestorer.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionRollbacker.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionSaver.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionUndoer.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/UserBlocker.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/UserCreator.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/UserGetter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/UserRightsChanger.php - https://github.com/addwiki/wikibase-api (25 tasks) [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/EntityApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/EntityRedirectApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/ItemApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/PropertyApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/TermApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/AliasGroupSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/BadgeIdsGetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/DescriptionSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/EntityDocumentSaver.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ItemMerger.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/LabelSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/RedirectCreator.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ReferenceRemover.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ReferenceSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/RevisionGetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/RevisionSaver.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/RevisionsGetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/SiteLinkLinker.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/SiteLinkSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/StatementCreator.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/StatementGetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/StatementRemover.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/StatementSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ValueFormatter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ValueParser.php Once you've added documentation to a feature, make sure to click "Edit Task" on https://phabricator.wikimedia.org/T145376 and change the checkbox from `[]` to `[X]` (to let others know that the feature has been documented).

All libraries that need documentation can be found at https://github.com/addwiki . Each of the libraries documentation is stored in the library repo within the '`docs'` directory. The documentation is written using the RST markup. An example commit introducing documentation for a single feature of one of the libraries can be found at https://github.com/addwiki/mediawiki-api/commit/b17ffb5b3294a0566afa6f0e4a07243fcb3c1529#diff-e3e2a9bfd88566b05001b02a3f51d286 **NOTE: T[found here](https://github.com/addwiki/mediawiki-api/commit/b17ffb5b3294a0566afa6f0e4a07243fcb3c1529#diff-e3e2a9bfd88566b05001b02a3f51d286) but note that the example commit includes an error, and [these services should not be constructed directly but instead retreived from the relevant factory ](https://github.com/addwiki/mediawiki-api/blob/b17ffb5b3294a0566afa6f0e4a07243fcb3c1529/src/MediawikiFactory.php#L125**). Features that need documentation can be found in the lists below: - https://github.com/addwiki/mediawiki-datamodel (14 tasks) [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Content.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/EditInfo.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/File.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Log.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/LogList.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/NamespaceInfo.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Page.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/PageIdentifier.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Pages.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Redirect.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Revision.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Revisions.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/Title.php [] https://github.com/addwiki/mediawiki-datamodel/blob/master/src/User.php - https://github.com/addwiki/mediawiki-api (21 tasks) [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/FileUploader.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/ImageRotator.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/LogListGetter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageDeleter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageListGetter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageMover.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageProtector.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PagePurger.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageRestorer.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/PageWatcher.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/Parser.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionDeleter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionPatroller.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionRestorer.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionRollbacker.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionSaver.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/RevisionUndoer.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/UserBlocker.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/UserCreator.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/UserGetter.php [] https://github.com/addwiki/mediawiki-api/blob/master/src/Service/UserRightsChanger.php - https://github.com/addwiki/wikibase-api (25 tasks) [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/EntityApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/EntityRedirectApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/ItemApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/PropertyApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Lookup/TermApiLookup.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/AliasGroupSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/BadgeIdsGetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/DescriptionSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/EntityDocumentSaver.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ItemMerger.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/LabelSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/RedirectCreator.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ReferenceRemover.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ReferenceSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/RevisionGetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/RevisionSaver.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/RevisionsGetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/SiteLinkLinker.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/SiteLinkSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/StatementCreator.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/StatementGetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/StatementRemover.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/StatementSetter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ValueFormatter.php [] https://github.com/addwiki/wikibase-api/blob/master/src/Api/Service/ValueParser.php For Google-Code-In it may make sense to have a single task for each feature in need of documentationOnce you've added documentation to a feature, make sure to click "Edit Task" on https://phabricator.wikimedia.org/T145376 and change the checkbox from `[]` to `[X]` (to let others know that the feature has been documented).