Skip to content

fixes #1176 (duplicate in doc)#1180

Merged
proux01 merged 1 commit intomath-comp:masterfrom
affeldt-aist:fix_1176
Mar 5, 2024
Merged

fixes #1176 (duplicate in doc)#1180
proux01 merged 1 commit intomath-comp:masterfrom
affeldt-aist:fix_1176

Conversation

@affeldt-aist
Copy link
Member

Motivation for this change

fixes #1176

It looks like some past merge has messed up with the documentation of measure.v.
It should be fixes now.

FYI: @yoshihiro503, @CohenCyril

Checklist

- [ ] added corresponding entries in CHANGELOG_UNRELEASED.md

  • added corresponding documentation in the headers

Reference: How to document

Reminder to reviewers

@affeldt-aist affeldt-aist added the documentation 📝 This issue/PR is about documentation of the library / repository label Mar 5, 2024
@affeldt-aist affeldt-aist added this to the 1.0.1 milestone Mar 5, 2024
@affeldt-aist affeldt-aist requested a review from proux01 March 5, 2024 05:26
(* Content_SubSigmaAdditive_isMeasure == mixin that extends a content to *)
(* a measure with the proof that it is *)
(* semi_sigma_additive *)
(* Content_isMeasure == mixin that extends a content to a measure *)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Well technically, mixins are factories, and the doc probably shouldn't care to document which factories are mixin or not (because the user shouldn't rely on that and doe not need to know it).

Copy link
Member Author

Choose a reason for hiding this comment

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

Should we call them all "interfaces"? "factory" is a bit HB-specific. "mixin" is not HB-specific but calling "mixins" "factories" might not help.

Copy link
Collaborator

Choose a reason for hiding this comment

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

At least factory is what it is called in the (the bit of) doc we have for HB. Not sure it would be easy to relate a new term like "interface" to that. And at least, factory conveys well the fact that the thing is used to build an instance of the structure. "interface" seems to vague to me.

(* The HB class is SFiniteMeasure. *)
(* sfinite_measure_seq mu == the sequence of finite measures of the *)
(* s-finite measure mu *)
(* Measure_isSFinite_subdef == mixin for s-finite measures *)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe this shouldn't be called _subdef if it needs to be documented?

@proux01 proux01 merged commit 7933dc1 into math-comp:master Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📝 This issue/PR is about documentation of the library / repository

Projects

None yet

Development

Successfully merging this pull request may close these issues.

typo, duplicate

2 participants