Page MenuHomePhabricator

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

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

Event Timeline

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)

WMDE-leszek renamed this task from Investigate & possibly create simple test making sure entity type defintion keys are documented. to Investigate & possibly create simple test making sure entity type defintion keys are documented. [8 hrs].Jan 12 2021, 2:28 PM
WMDE-leszek added a subscriber: WMDE-leszek.

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

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):

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

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

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

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!