Closed, ResolvedPublic
Actions

Assigned To

Authored By

	Mateusz_Konieczny
	Jul 27 2017, 7:01 PM

Description

I searched at https://doc.wikimedia.org/pywikibot/ for bug/tracker/issue

It contains link to https://www.mediawiki.org/wiki/Manual:Pywikibot that mentions where bugs are listed, but bug tracker should be also linked directly

Details

	Subject	Repo	Branch	Lines +/-
	[doc] Add bug tracker at https://doc.wikimedia.org/pywikibot/	pywikibot/core	master	+5 -9

Customize query in gerrit

Related Objects

Mentioned Here: T171886: installing pywikibot with pip fails because the package isn't a git repository; setup.py is unable to find the version of pywikibot

Event Timeline

Mateusz_Konieczny created this task.Jul 27 2017, 7:01 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJul 27 2017, 7:01 PM

Framawiki added projects: Pywikibot-General, Pywikibot-Documentation, Pywikibot.Jul 27 2017, 10:56 PM

Restricted Application added a project: Documentation. · View Herald TranscriptJul 27 2017, 10:56 PM

Restricted Application added a subscriber: pywikibot-bugs-list. · View Herald Transcript

Framawiki triaged this task as Low priority.Jul 27 2017, 10:57 PM

binbot subscribed.Jul 28 2017, 7:26 AM

I don't know. The purpose of a documentation is to document classes, functions, variables, getters and setters, possibly usage. The link to the bug tracker is on the right place: on the Pywikibot "homepage". The only reason I see could be if somebody wants to fill in a bug in documentation, which is not as usual as somebody might think for pwb

In my opinion ideal documentation is not only documenting code (classes etc) and usage but structure of project (is it active, where one may report bugs, send patches...).

In my case I was trying to report T171886 - and finding place to report pywikibot bugs was not as obvious as it can be.

Iff pywikibot documentation is intended to describe solely code - that is a design decision that is mostly subjective, so feel free to close this suggestion if it is not considered as something worth doing.

As I said before, the Pywikibot homepage should be the first and also the last place to search for everything. On MediaWiki there is also a solid manual and documentation, how to install, configure, use Pywikibot and contribute to Pywikibot. The documentation you mentioned (like documentation for programming languages) is just an addition to source code, it is automatically generated from comments in source code and only documents the code itself: API. You can compare this approach with e.g. Dart programming language, which has got a similar approach. There is also a wider, but outdated documentation on Readthedocs, but once more this is automatically generated from the source code and once more it documents only the API.

Change 370186 had a related patch set uploaded (by Xqt; owner: Xqt):
[pywikibot/core@master] [doc] Add bug tracker at https://doc.wikimedia.org/pywikibot/

https://gerrit.wikimedia.org/r/370186

gerritbot added a project: Patch-For-Review.Aug 4 2017, 12:11 PM

First I agree with Dvorapa to keep the main documentation at mediawiki.org except of the code documentation itself whereas https://doc.wikimedia.org/pywikibot is mainly for the code. I guess the inital intention and steps of having the documentation at https://doc.wikimedia.org/pywikibot had an opposite meaning. On the other hand I think some additional informations could also placed there like some abstracts and (imho importand) where to find related and further informations. I mean a link to the bug tracker could be placed at the same place where to get further help which links to the wikimedia manual.

Change 370186 merged by jenkins-bot:
[pywikibot/core@master] [doc] Add bug tracker at https://doc.wikimedia.org/pywikibot/