Skip to content

Documentation differentiation - #2053

Open
yosakaon wants to merge 8 commits into
math-comp:masterfrom
yosakaon:27juil
Open

Documentation differentiation #2053
yosakaon wants to merge 8 commits into
math-comp:masterfrom
yosakaon:27juil

Conversation

@yosakaon

@yosakaon yosakaon commented Jul 27, 2026

Copy link
Copy Markdown
Contributor
Motivation for this change

This PR fixes #1996 and #1839, in particular the use of is_diff and is_derive

Checklist
  • added corresponding entries in CHANGELOG_UNRELEASED.md
  • added corresponding documentation in the headers

Reference: How to document

Merge policy

As a rule of thumb:

  • PRs with several commits that make sense individually and that
    all compile are preferentially merged into master.
  • PRs with disorganized commits are very likely to be squash-rebased.
Reminder to reviewers

Comment thread theories/derive.v Outdated
Comment thread theories/derive.v Outdated
Comment thread theories/derive.v Outdated
Comment thread theories/derive.v Outdated
Comment thread theories/derive.v Outdated
Comment thread theories/derive.v Outdated
Comment on lines +67 to +72
(* `Lemma is_derive_example (W : normedModType R) *)
(* (t : R^o) (f g : R^o -> W) (f' g' : W) v : *)
(* is_derive t v f f' -> *)
(* is_derive t v g g' -> *)
(* is_derive t v (f + g) (f' + g'). *)
(* Proof. move => is_der_f is_der_g. by apply: is_derive_eq. Qed.` *)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is maybe better to put this piece of code between triple backquotes.

Comment thread theories/derive.v Outdated
Comment thread theories/derive.v Outdated
Comment on lines +80 to +88
(* Hypothesis derivable_f : forall t, derivable f t 1. *)
(* Hypothesis derivable_h : forall t, derivable h t 1. *)
(* Local Instance is_derive_f t : is_derive t 1 f ('D_1 f t). *)
(* by apply: derivableP. Qed. *)
(* Local Instance is_derive_h t : is_derive t 1 h ('D_1 h t). *)
(* by apply: derivableP. Qed. *)
(* *)
(* Lemma is_derivable_example (t : R^o) : derivable (f+h) t 1. *)
(* Proof. apply/ex_derive. Qed. *)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe better inside a pair of triple backquotes.

Comment thread theories/derive.v Outdated
(* To verify the value of a given function you can apply `derive_val` or *)
(* diff_val`, given the right `is_derive/diff` instances are defined such as :*)
(* *)
(* Lemma is_derive_val_example t : *)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here about triple backquotes.

@affeldt-aist affeldt-aist left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many thanks for writing this done!

@affeldt-aist

Copy link
Copy Markdown
Member

Note that you can check the automatically generated documentation of this PR by downloading the artifact produced by the CI job generate-artifact (but it takes a while...).

@yosakaon
yosakaon requested a review from affeldt-aist July 28, 2026 15:30
@yosakaon

Copy link
Copy Markdown
Contributor Author

Note that you can check the automatically generated documentation of this PR by downloading the artifact produced by the CI job generate-artifact (but it takes a while...).

It seems like the CI fails before generating documentation

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.

is_diff is not documented in the header

2 participants