Skip to content

fix: have Lake not create core aliases into Lake namespace#5688

Merged
kmill merged 2 commits intoleanprover:masterfrom
kmill:lake-no-export
Oct 20, 2024
Merged

fix: have Lake not create core aliases into Lake namespace#5688
kmill merged 2 commits intoleanprover:masterfrom
kmill:lake-no-export

Conversation

@kmill
Copy link
Copy Markdown
Collaborator

@kmill kmill commented Oct 13, 2024

This replaces export Lean (Name NameMap) and export System (SearchPath FilePath) with the relevant open commands. This fixes docgen output so that it can refer to, for example, Lean.Name instead of Lake.Name.

The reason for these exports was convenience: by doing open Lake you could get these aliases for free. However, aliases affect pretty printing, and the Lake aliases took precedence. We don't want to disable pretty printing re-exported names because this can be a valid pattern (names could incrementally get re-exported from namespace to parent namespace).

In the future we might implement a feature to be able to scoped open some names.

Breaking change: Lakefiles that refer to FilePath may need to change this to System.FilePath or otherwise add open System (FilePath).

Closes #2524

@kmill kmill requested a review from tydeu as a code owner October 13, 2024 17:34
@github-actions github-actions bot added the toolchain-available A toolchain is available for this PR, at leanprover/lean4-pr-releases:pr-release-NNNN label Oct 13, 2024
ghost pushed a commit to leanprover-community/batteries that referenced this pull request Oct 13, 2024
ghost pushed a commit to leanprover-community/mathlib4 that referenced this pull request Oct 13, 2024
@ghost
Copy link
Copy Markdown

ghost commented Oct 13, 2024

Mathlib CI status (docs):

kmill added 2 commits October 20, 2024 10:54
This replaces `export Lean (Name NameMap)` and `export System (SearchPath FilePath)` with the relevant `open` commands. This fixes docgen output so that it can refer to, for example, `Lean.Name` instead of `Lake.Name`.

The reason for these `export`s was convenience: by doing `open Lake` you could get these aliases for free. However, aliases affect pretty printing, and the Lake aliases took precedence. We don't want to disable pretty printing re-exported names because this can be a valid pattern (names could incrementally get re-exported from namespace to parent namespace).

In the future we might implement a feature to be able to `scope export` some names.

Closes leanprover#2524
@kmill kmill enabled auto-merge October 20, 2024 18:23
@kmill kmill added this pull request to the merge queue Oct 20, 2024
ghost pushed a commit to leanprover-community/batteries that referenced this pull request Oct 20, 2024
ghost pushed a commit to leanprover-community/mathlib4 that referenced this pull request Oct 20, 2024
Merged via the queue into leanprover:master with commit 46f1335 Oct 20, 2024
tobiasgrosser pushed a commit to opencompl/lean4 that referenced this pull request Oct 27, 2024
…rover#5688)

This replaces `export Lean (Name NameMap)` and `export System
(SearchPath FilePath)` with the relevant `open` commands. This fixes
docgen output so that it can refer to, for example, `Lean.Name` instead
of `Lake.Name`.

The reason for these `export`s was convenience: by doing `open Lake` you
could get these aliases for free. However, aliases affect pretty
printing, and the Lake aliases took precedence. We don't want to disable
pretty printing re-exported names because this can be a valid pattern
(names could incrementally get re-exported from namespace to parent
namespace).

In the future we might implement a feature to be able to `scoped open`
some names.

Breaking change: Lakefiles that refer to `FilePath` may need to change
this to `System.FilePath` or otherwise add `open System (FilePath)`.

Closes leanprover#2524
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

toolchain-available A toolchain is available for this PR, at leanprover/lean4-pr-releases:pr-release-NNNN

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Delaboration of re-exported names

2 participants