diff options
| author | Anton Trunov | 2018-11-27 12:17:47 +0100 |
|---|---|---|
| committer | Anton Trunov | 2018-12-04 12:43:20 +0100 |
| commit | 8c82657e7692049dde4a4c44a2ea53d0c4fa7cb5 (patch) | |
| tree | c973a8517cb257f127c60299e86d3f553ba51462 /mathcomp/character/mxrepresentation.v | |
| parent | add6e85884691faef1bf8742e803374815672cc2 (diff) | |
Document parameter names whenever possible
As suggested by @ggonthier
[here](https://github.com/math-comp/math-comp/pull/249#pullrequestreview-177938295)
> One of the design ideas for the `Arguments` command was that it would allow
to centralise the documentation of the application of constants.
In that spirit it would be in my opinion better to make as much use of this
as possible, and to document the parameter names whenever possible,
especially that of implicit parameters.
and
[here](https://github.com/math-comp/math-comp/pull/253#discussion_r237434163):
> As a general rule, defined functional constants should have maximal prenex
implicit arguments, as this facilitates their use as arguments to functionals,
because this mimics the way function constants are treated in functional
programming languages with Hindley-Milner type inference. Conversely, lemmas and
theorems should have on-demand implicit arguments, possibly interspersed with
explicit ones, as it's fairly common for other lemmas to have universally
quantified premises; also, this makes it easier to specify such arguments with
the apply: tactic. This policy may be amended for lemmas that are used as
functional arguments, such as reflection or cancellation lemmas. Unfortunately
there is currently no easy way to tell Coq to use different defaults for
definitions and lemmas, so MathComp sticks to the on-demand default, as there
are significantly more lemmas than definition, and use the Prenex Implicits to
redress matters in bulk for definitions. However, this is not completely
systematic, and is sometimes omitted for constants that are not used as
functional arguments in the library, or inside the sections in which the
definition occur, since such commands need to be repeated after the section is
closed. Since Arguments commands should document the intended constant usage as
best as possible, they should follow the implicits policy - even in cases such
as this where the Prenex Implicits had been skipped.
Diffstat (limited to 'mathcomp/character/mxrepresentation.v')
| -rw-r--r-- | mathcomp/character/mxrepresentation.v | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/mathcomp/character/mxrepresentation.v b/mathcomp/character/mxrepresentation.v index 6859168..560b61d 100644 --- a/mathcomp/character/mxrepresentation.v +++ b/mathcomp/character/mxrepresentation.v @@ -814,10 +814,10 @@ End Regular. End RingRepr. -Arguments mx_representation _ _ _%g _%N. -Arguments mx_repr _ _ _%g _%N _. -Arguments group_ring _ _ _%g. -Arguments regular_repr _ _ _%g. +Arguments mx_representation R {gT} G%g n%N. +Arguments mx_repr {R gT} G%g {n%N} r. +Arguments group_ring R {gT} G%g. +Arguments regular_repr R {gT} G%g. Arguments centgmxP {R gT G n rG f}. Arguments rkerP {R gT G n rG x}. @@ -2377,8 +2377,8 @@ Arguments mxsimple_isoP {gT G n rG U V}. Arguments socleP {gT G n rG sG0 W W'}. Arguments mx_abs_irrP {gT G n rG}. -Arguments val_submod_inj {n U m}. -Arguments val_factmod_inj {n U m}. +Arguments val_submod_inj {n U m} [W1 W2] : rename. +Arguments val_factmod_inj {n U m} [W1 W2] : rename. Section Proper. @@ -4652,10 +4652,10 @@ End LinearIrr. End FieldRepr. -Arguments rfix_mx _ _ _%g _%N _ _%g. -Arguments gset_mx _ _ _%g _%g. -Arguments classg_base _ _ _%g _%g : extra scopes. -Arguments irrType _ _ _%g _%g : extra scopes. +Arguments rfix_mx {F gT G%g n%N} rG H%g. +Arguments gset_mx F {gT} G%g A%g. +Arguments classg_base F {gT} G%g _%g : extra scopes. +Arguments irrType F {gT} G%g. Arguments mxmoduleP {F gT G n rG m U}. Arguments envelop_mxP {F gT G n rG A}. @@ -4671,16 +4671,16 @@ Arguments socleP {F gT G n rG sG0 W W'}. Arguments mx_abs_irrP {F gT G n rG}. Arguments socle_rsimP {F gT G n rG sG W1 W2}. -Arguments val_submod_inj {F n U m}. -Arguments val_factmod_inj {F n U m}. +Arguments val_submod_inj {F n U m} [W1 W2] : rename. +Arguments val_factmod_inj {F n U m} [W1 W2] : rename. Notation "'Cl" := (Clifford_action _) : action_scope. Bind Scope irrType_scope with socle_sort. Notation "[ 1 sG ]" := (principal_comp sG) : irrType_scope. -Arguments irr_degree _ _ _%G _ _%irr. -Arguments irr_repr _ _ _%G _ _%irr _%g : extra scopes. -Arguments irr_mode _ _ _%G _ _%irr _%g : extra scopes. +Arguments irr_degree {F gT G%G sG} i%irr. +Arguments irr_repr [F gT G%G sG] i%irr _%g : extra scopes. +Arguments irr_mode [F gT G%G sG] i%irr z%g : rename. Notation "''n_' i" := (irr_degree i) : group_ring_scope. Notation "''R_' i" := (Wedderburn_subring i) : group_ring_scope. Notation "''e_' i" := (Wedderburn_id i) : group_ring_scope. |
