8000 Fix naming inconsistencies between `imset` and `map` lemmas. by chdoc · Pull Request #592 · math-comp/math-comp · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix naming inconsistencies between imset and map lemmas. #592

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.

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

Merged
merged 4 commits into from
Sep 29, 2020

Conversation

chdoc
Copy link
Member
@chdoc chdoc commented Sep 10, 2020
Motivation for this change

fixes #508 (the first stage)

Things done/to do
  • added corresponding entries in CHANGELOG_UNRELEASED.md (do not edit former entries)
  • added corresponding documentation in the headers
  • after merging, add issues to remove the deprecated lemmas and rename the mem_imsert_eq lemmas.
Automatic note to reviewers

Read this Checklist and make sure there is a milestone.

@chdoc chdoc changed the title Mem imset Fix naming inconsistencies between imset and map lemmas. Sep 10, 2020
@chdoc
Copy link
Member Author
chdoc commented Sep 16, 2020

@CohenCyril @gares can I get an assignee?

@CohenCyril CohenCyril self-assigned this Sep 16, 2020
@CohenCyril
Copy link
Member
CohenCyril commented Sep 16, 2020

@ggonthier @thery could you review this PR?

@@ -40,6 +40,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- in `finset.v`, new lemmas: `properC`, `properCr`, `properCl`
- in `ssrnat.v`, new lemmas: `subn_minl`, `subn_maxl`
- in `ssrnat.v`, new lemma: `oddS`
- in `finset.v`, new lemmas: `mem_imset_eq`, `mem_imset2_eq`.
Ideal names would be `mem_imset` and `mem_imset2`, but these names have just been deprecated from their previous meaning.
Copy link
Member

Choose a reason for hiding this comment

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

Don't like this idea of temporary name. @maximedenes how coq deals with this kind of situation?

Copy link
Member
@CohenCyril CohenCyril Sep 28, 2020

Choose a reason for hiding this comment

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

This strategy was discussed here I cannot recall whether @maximedenes attended though...

Copy link
Member

Choose a reason for hiding this comment

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

I wasn't there either 😉 still not a fan of temporary names

Copy link
Member

Choose a reason for hiding this comment

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

You can say "these names will lose the _eq suffix in the next release", it may be of interest to the user. The reason why is not really helping IMO, and here you are not anyway suggesting we plan to use the ideal names in the future.

Copy link
Member

Choose a reason for hiding this comment

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

I don't recall a case like this in Coq.

Copy link
Member

Choose a reason for hiding this comment

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

If everybody like temporary names, then @CohenCyril could already make the next pull request for 1.13 so we are sure theses names wil disappear.

Copy link
Member Author

Choose a reason for hiding this comment

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

Don't like this idea of temporary name. @maximedenes how coq deals with this kind of situation?

I don't like the temporary names either, but I don't see another way without causing a breaking change. And this seems to minor an issue to cause a breaking change.

You can say "these names will lose the _eq suffix in the next release", it may be of interest to the user. The reason why is not really helping IMO, and here you are not anyway suggesting we plan to use the ideal names in the future.

I was merely following the formulations used by Cyril in #492

If everybody like temporary names, then @CohenCyril could already make the next pull request for 1.13 so we are sure theses names wil disappear.

This is an "after merge" Item, again as in #492

Copy link
Member Author

Choose a reason for hiding this comment

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

It can't be a pull request yet, because the things to be removed aren't there yet ...

Copy link
Member

Choose a reason for hiding this comment

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

@chdoc sorry I am reviewing too many pull requests by cyril I thought it was one of his too.

Copy link
Member
@CohenCyril CohenCyril Sep 28, 2020

Choose a reason for hiding this comment

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

It can't be a pull request yet, because the things to be removed aren't there yet ...

Actually, it could be, I did not think about it before, but it just needs to be a pr on top of this one 😆

@thery thery added the kind: refactoring Issue or PR about a refactoring. (reorganizing the code, reusing theorems, simplifications...) label Sep 29, 2020
@thery thery added this to the 1.12.0 milestone Sep 29, 2020
@thery
Copy link
Member
thery commented Sep 29, 2020

@chdoc if you change the wording as sugested by @gares I think we can merge this PR

@chdoc
Copy link
Member Author
chdoc commented Sep 29, 2020

Reworded and rebased.

@CohenCyril
Copy link
Member
CohenCyril commented Sep 29, 2020

@thery waiting for your "green tick" ✔️ 😉

@thery
Copy link
Member
thery commented Sep 29, 2020

✔️

@CohenCyril
Copy link
Member

... I meant "Approve PR" and stuff, but that works for me too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: refactoring Issue or PR about a refactoring. (reorganizing the code, reusing theorems, simplifications...)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

mem_imset mem_map naming/statement inconsistency
4 participants
0