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.

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

Towards a more uniform API for declare.ml (part declaring mutual statements) #18795

Merged
merged 12 commits into from
May 28, 2024

Conversation

herbelin
Copy link
Member

@herbelin herbelin commented Mar 14, 2024

The purpose of this PR is to present some uniformity in the API of declare.ml so that it is clearer to compare the different functions. It should not change the semantics.

Depends on #18742 and #18743 (merged).

It has an impact on the exact API though with the following API changes:

  • function renamings

    • declare_mutually_recursive -> declare_mutual_definition (+ label rec_declaration -> bodies), consistently with declare_definition
    • start_with_initialization -> start_definition
    • start_mutual_with_initialization -> start_mutual_definition (+ label init_term -> bodies)
  • other labels renaming

    • in add_definition: term -> body, and opaque made mandatory
    • in add_mutual_definitions: argument (cinfo,bodies,obls) -> labels cinfo and bodies + obls kept as unnamed argument
  • TODO, pending question: mutual_definition or mutual_definitions?

Overlays (due to opaque made mandatory)

@herbelin herbelin added kind: cleanup Code removal, deprecation, refactorings, etc. needs: merge of dependency This PR depends on another PR being merged first. part: vernac High level command interpretation. labels Mar 14, 2024
@herbelin herbelin added this to the 8.20+rc1 milestone Mar 14, 2024
@coqbot-app coqbot-app bot added the needs: rebase Should be rebased on the latest master to solve conflicts or have a newer CI run. label Mar 14, 2024
@herbelin herbelin force-pushed the master+uniform-API-declare.ml branch from 23ea0f6 to aa23b15 Compare March 14, 2024 13:51
@coqbot-app coqbot-app bot added needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. and removed needs: rebase Should be rebased on the latest master to solve conflicts or have a newer CI run. labels Mar 14, 2024
@herbelin herbelin added the request: full CI Use this label when you want your next push to trigger a full CI. label Mar 15, 2024
@herbelin herbelin force-pushed the master+uniform-API-declare.ml branch from aa23b15 to 036a797 Compare March 15, 2024 08:59
@coqbot-app coqbot-app bot removed request: full CI Use this label when you want your next push to trigger a full CI. needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. labels Mar 15, 2024
@herbelin herbelin marked this pull request as ready for review March 15, 2024 08:59
@herbelin herbelin requested review from a team as code owners March 15, 2024 08:59
@github-actions github-actions bot added the needs: rebase Should be rebased on the latest master to solve conflicts or have a newer CI run. label Mar 21, 2024
@herbelin herbelin force-pushed the master+uniform-API-declare.ml branch from 036a797 to 510069e Compare March 23, 2024 08:56
@coqbot-app coqbot-app bot added needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. and removed needs: rebase Should be rebased on the latest master to solve conflicts or have a newer CI run. labels Mar 23, 2024
@github-actions github-actions bot added the needs: rebase Should be rebased on the latest master to solve conflicts or have a newer CI run. label Apr 3, 2024
@herbelin herbelin force-pushed the master+uniform-API-declare.ml branch from 510069e to 658fb69 Compare April 6, 2024 09:21
@coqbot-app coqbot-app bot removed the needs: rebase Should be rebased on the latest master to solve conflicts or have a newer CI run. label Apr 6, 2024
@herbelin herbelin added the request: full CI Use this label when you want your next push to trigger a full CI. label Apr 12, 2024
@herbelin herbelin force-pushed the master+uniform-API-declare.ml branch from 658fb69 to 5c8cd90 Compare April 12, 2024 17:27
@coqbot-app coqbot-app bot removed request: full CI Use this label when you want your next push to trigger a full CI. needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. labels Apr 12, 2024
@herbelin herbelin added the request: full CI Use this label when you want your next push to trigger a full CI. label Apr 19, 2024
@coqbot-app coqbot-app bot added the needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. label May 21, 2024
@ejgallego
Copy link
Member

The most conservative would be mutual definitions since it would preserve the old name add_mutual_definitions, so I'm leaning for it.

Sounds good @herbelin , I have no strong opinion, if we find a better name we can change it later of course.

@herbelin
Copy link
Member Author

Adopting the plural form then.

@github-actions github-actions bot added the needs: rebase Should be rebased on the latest master to solve conflicts or have a newer CI run. label May 24, 2024
@herbelin herbelin added the request: full CI Use this label when you want your next push to trigger a full CI. label May 25, 2024
@herbelin herbelin force-pushed the master+uniform-API-declare.ml branch from 317a52e to 3c84501 Compare May 26, 2024 07:48
@coqbot-app coqbot-app bot removed needs: rebase Should be rebased on the latest master to solve conflicts or have a newer CI run. request: full CI Use this label when you want your next push to trigger a full CI. needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. labels May 26, 2024
@ppedrot ppedrot self-assigned this May 28, 2024
@ppedrot
Copy link
Member

ppedrot commented May 28, 2024

@coqbot merge now

@coqbot-app coqbot-app bot merged commit 7e92c03 into coq:master May 28, 2024
7 checks passed
Copy link
Contributor

coqbot-app bot commented May 28, 2024

@ppedrot: Please take care of the following overlays:

  • 18795-herbelin-master+uniform-API-declare.ml.sh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: cleanup Code removal, deprecation, refactorings, etc. part: vernac High level command interpretation.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants