[8h] Investigate & possibly create simple test making sure entity type defintion keys are documented.
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	Addshore
	Feb 17 2020, 9:49 AM

Description

In T243518#5888875 I suggest the idea of a test to make sure that https://doc.wikimedia.org/Wikibase/master/php/md_docs_topics_entitytypes.html is kept up to date with the ways an entity can be configured and defined.

AC:

Check whether it is possible to write tests to make sure that the docs stay up to date with any newly created entity type config keys.
Write said tests OR close this task if the effort is too big.

Timebox: 8h 5h

Details

	Subject	Repo	Branch	Lines +/-
	Ensure all entity type definition fields are documented	mediawiki/extensions/Wikibase	master	+66 -2

Customize query in gerrit

Related Objects

Mentioned Here: T243518: Document things like entity-reference-extractor-callback for entity type definitions on doc.wikimedia.org for wikibase

Event Timeline

Addshore created this task.Feb 17 2020, 9:49 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 17 2020, 9:49 AM

Addshore triaged this task as Lowest priority.Feb 18 2020, 9:49 AM

Addshore moved this task from Incoming to Prioritized Wikidata Tech Backlog (prioritised from top to bottom) on the Wikidata-Campsite board.

From the prio session:

If this turns out to be difficult then the outcome should be that we don't do it at all.
Should be timeboxed.

We also discussed making a bigger change to make this sort of docs not so important. (ticket pending)

ItamarWMDE updated the task description. (Show Details)Jan 12 2021, 1:21 PM

Investigation and creating a test should not take longer than 8 personhours.

WMDE-leszek moved this task from Prioritized Wikidata Tech Backlog (prioritised from top to bottom) to Wikidata-Campsite-Iteration-∞ (On Hold) on the Wikidata-Campsite board.Jan 12 2021, 2:29 PM

WMDE-leszek edited projects, added Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)); removed Wikidata-Campsite.

noarave renamed this task from Investigate & possibly create simple test making sure entity type defintion keys are documented. [8 hrs] to [8h] Investigate & possibly create simple test making sure entity type defintion keys are documented. [8 hrs].Jan 12 2021, 2:59 PM

noarave renamed this task from [8h] Investigate & possibly create simple test making sure entity type defintion keys are documented. [8 hrs] to [8h] Investigate & possibly create simple test making sure entity type defintion keys are documented. .

Notes from the task inspection (some possible directions to start this off):

find the origin of https://doc.wikimedia.org/Wikibase/master/php/md_docs_topics_entitytypes.html and use the markdown as comparison source (haystack)
make sure all the public consts of the EntityTypeDefinitions class are present in the markdown

Maintenance_bot moved this task from incoming to in progress on the Wikidata board.Jan 12 2021, 3:15 PM

Lucas_Werkmeister_WMDE claimed this task.Jan 21 2021, 11:27 AM

Lucas_Werkmeister_WMDE moved this task from To Do (prioritised from top to bottom) to Doing on the Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)) board.

There’s a surprising number of undocumented keys:

..F.F......F...FFF..............FFFFF..

Change 657618 had a related patch set uploaded (by Lucas Werkmeister (WMDE); owner: Lucas Werkmeister (WMDE)):
[mediawiki/extensions/Wikibase@master] Ensure all entity type definition fields are documented

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

gerritbot added a project: Patch-For-Review.Jan 21 2021, 3:09 PM

Lucas_Werkmeister_WMDE moved this task from Doing to Peer Review on the Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)) board.Jan 21 2021, 3:10 PM

Lucas_Werkmeister_WMDE updated the task description. (Show Details)

Change 657618 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] Ensure all entity type definition fields are documented

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

ReleaseTaggerBot added a project: MW-1.36-notes (1.36.0-wmf.28; 2021-01-26).Jan 25 2021, 4:00 PM

Maintenance_bot removed a project: Patch-For-Review.Jan 25 2021, 4:10 PM

Lucas_Werkmeister_WMDE moved this task from Peer Review to Test (Verification) on the Wikidata-Campsite (Wikidata-Campsite-Iteration-∞ (On Hold)) board.Jan 25 2021, 4:15 PM

In T245405#6765037, @Lucas_Werkmeister_WMDE wrote:
There’s a surprising number of undocumented keys:
..F.F......F...FFF..............FFFFF..

I'm glad we wrote this test :)
Thanks for the doc improvements that came with it!

[8h] Investigate & possibly create simple test making sure entity type defintion keys are documented. Closed, ResolvedPublicActions

Description

Details

Related Objects

Event Timeline

[8h] Investigate & possibly create simple test making sure entity type defintion keys are documented.
Closed, ResolvedPublic
Actions