Skip to content

Conversation

amire80
Copy link
Collaborator

@amire80 amire80 commented Oct 13, 2025

Description (required)

This patch adds a test for missing string documentation. Similar tests exist in Gerrit for MediaWiki and in the Wikipedia Android app, because complete documentation for every translatable string is very helpful to translators and developers.

THIS IS SUPPOSED TO FAIL AT THE MOMENT.

Documentation for all the strings is already written in translatewiki (see #6457), but not yet imported into GitHub, so it's supposed to fail now, which is good because you shouldn't trust tests that never failed :)

Once all the documentation strings are imported, this pull request should be rebased, and then it's supposed to pass.

The extra string in values-qq/string.xml is also there just to check that it fails as it should, and will be removed.

Resolves #6485.

Tests performed (required)

Tested locally using ./gradlew testBetaDebugUnitTest. This test (intentionally) failed, and gave a readable error description in the generated report.

@amire80 amire80 force-pushed the test-qq branch 3 times, most recently from 0b4af5c to 38dd44b Compare October 13, 2025 22:16
THIS IS SUPPOSED TO FAIL AT THE MOMENT.

Documentation for all the strings is already written
in translatewiki (see commons-app#6457), but not yet imported into GitHub,
so it's supposed to fail now, which is good because you shouldn't trust
tests that never failed :)

Once all the documentation strings are imported, this pull request
should be rebased, and then it's supposed to pass.

The extra string in values-qq/string.xml is also there
just to check that it fails as it should, and will be removed.

Resolves commons-app#6485.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

automatically test for missing string documentation

1 participant