Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation header issues? #157

Closed
amahboubi opened this issue Oct 4, 2019 · 1 comment · Fixed by #449
Closed

Documentation header issues? #157

amahboubi opened this issue Oct 4, 2019 · 1 comment · Fixed by #449
Labels
documentation 📝 This issue/PR is about documentation of the library / repository
Milestone
0.3.11

Comments

@amahboubi
Copy link
Member

A few lines in the header of topology.v are confusing, specially those which deal with filtered types.
For instance :

  • at this line, what does "canonical" mean here? Should it be "T must be a filteredType?
  • at this one, isn't T inferred from F itself? The word canonical seems misleading here.
@amahboubi amahboubi added the documentation 📝 This issue/PR is about documentation of the library / repository label Oct 4, 2019
@amahboubi
Copy link
Member Author

More generally, I guess the header should explain the meaning of "canonical filter" everywhere in the header.

@affeldt-aist affeldt-aist added this to the 0.3.7 milestone Jan 27, 2021
@affeldt-aist affeldt-aist modified the milestones: 0.3.7, 0.3.8 Apr 1, 2021
@affeldt-aist affeldt-aist modified the milestones: 0.3.8, 0.3.9 Jun 1, 2021
@affeldt-aist affeldt-aist modified the milestones: 0.3.9, 0.3.10 Jun 14, 2021
@affeldt-aist affeldt-aist modified the milestones: 0.3.10, 0.3.11 Aug 11, 2021
affeldt-aist added a commit that referenced this issue Oct 4, 2021
@affeldt-aist
documentation improvement
1612b08 
- fixes #157
- fixes #448
@affeldt-aist affeldt-aist mentioned this issue Oct 4, 2021
Merged
affeldt-aist added a commit that referenced this issue Oct 7, 2021
@affeldt-aist
documentation improvement
52d3b1b 
- fixes #157
- fixes #448
affeldt-aist added a commit that referenced this issue Oct 21, 2021
@affeldt-aist
documentation improvement
9a093ce 
- fixes #157
- fixes #448
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation 📝 This issue/PR is about documentation of the library / repository
Projects
None yet
Milestone
0.3.11
Development

Successfully merging a pull request may close this issue.

documentation improvement math-comp/analysis
2 participants
@amahboubi @affeldt-aist