Skip to content

Commit d9421e1

Browse files
committed
Expand the description of the RequireMetadata PG::Critic policy.
1 parent bfd1330 commit d9421e1

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

lib/Perl/Critic/Policy/PG/RequireMetadata.pm

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,15 @@ metadata attributes should be set at the beginning of the problem file before
4848
the C<DOCUMENT> call. The metadata tags that are required for all problems are
4949
C<DBsubject>, C<DBchapter>, C<DBsection>, and C<KEYWORDS>.
5050
51+
The C<DBsubject>, C<DBchapter>, C<DBsection> tags can only be specific values.
52+
The prefered way to edit these tags is to use the tag editor (click "Edit Tags"
53+
when viewing the problem). The tag editor provides drop down menus to choose
54+
between the valid possibilities.
55+
56+
Since OPL metadata tags are only needed for problems in the OPL, for local
57+
problems it is possible to override this check by adding the following as
58+
the first line of the PG file.
59+
60+
## no critic (PG::RequireMetadata)
61+
5162
=cut

0 commit comments

Comments
 (0)