Skip to content

Commit

Permalink
Docs: reword checks so test->checks, override->mute
Browse files Browse the repository at this point in the history
  • Loading branch information
dwaynebailey committed Jun 20, 2016
1 parent 1dafd79 commit af296d3
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions docs/features/checks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Quality checks
==============

Pootle provides a powerful way of reviewing translations for quality. It
exposes most of the :ref:`pofilter tests <toolkit:pofilter_tests>` that can
test for several issues that can affect the quality of your translations.
exposes most of the :ref:`pofilter checks <toolkit:pofilter_tests>` that can
check for several issues that can affect the quality of your translations.

If Pootle indicates a possible problem with a translation, it doesn't mean that
the translation is necessarily wrong, just that you might want to review it.
Expand All @@ -19,33 +19,33 @@ Critical checks are prominently displayed through the browsing UI.

Any extra failing checks can be accessed by clicking the
|icon:icon-expand-stats| button located below the navigation breadcrumbs.
Clicking on the name of a test will step you through the translations that fail
that test.
Clicking on the name of a check will step you through the translations that
fail that check.

While in the translation editor, submissions resulting in critical failing
checks will be immediately reported, preventing you from automatically
continuing until the issues have been resolved or muted as false positives by
using the mute |icon:icon-block| button. Non-crtical errors flag potential
using the mute |icon:icon-block| button. Non-critical checks flag potential
problems but can be ignored or muted as needed.

.. image:: ../_static/failing-checks.png

To understand the meaning of each test, Pootle displays the failing tests
right on top of the submission button, with a link to the online
documentation. You can also read the detailed descriptions of the
:ref:`pofilter tests <toolkit:test_description>`.
To understand the meaning of each check, Pootle displays the failing checks
right on top of the submission button, with a link to the online documentation.
You can also read the detailed descriptions of the :ref:`pofilter checks
<toolkit:test_description>`.


.. _checks#overriding_quality_checks:
.. _checks#muting_quality_checks:

Overriding Quality Checks
-------------------------
Muting Quality Checks
---------------------

It is possible to override the quality check if the translation is correct.
It is possible to mute the quality check if the translation is correct.
Reviewers are able to remove the check for a certain string, by clicking on the
|icon:icon-block| button, to indicate that the string is correctly translated.
This avoids having to recheck the same checks multiple times. You can off
course unmute the test using the |icon:icon-block-muted| button.
This avoids having to review the same check multiple times. You can unmute any
muted check using the |icon:icon-block-muted| button.

If the translation is changed, the override information is discarded to ensure
that the new translation is tested again for any possible issues.
If the source text of the translation is changed then the mute is discarded to
ensure that the new translation is checked again for any possible issues.

0 comments on commit af296d3

Please sign in to comment.