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

[Merged by Bors] - doc(Cache/Hashing): add docstring for HashMemo #21711

Closed
wants to merge 11 commits into from

Conversation

joneugster
Copy link
Collaborator


Open in Gitpod

@joneugster joneugster added documentation Improvements or additions to documentation easy < 20s of review time. See the lifecycle page for guidelines. t-meta Tactics, attributes or user commands labels Feb 11, 2025
Copy link

github-actions bot commented Feb 11, 2025

PR summary e88a97b477

Import changes for modified files

No significant changes to the import graph

Import changes for all files
Files Import difference

Declarations diff

No declarations were harmed in the making of this PR! 🐙

You can run this locally as follows
## summary with just the declaration names:
./scripts/declarations_diff.sh <optional_commit>

## more verbose report:
./scripts/declarations_diff.sh long <optional_commit>

The doc-module for script/declarations_diff.sh contains some details about this script.


No changes to technical debt.

You can run this locally as

./scripts/technical-debt-metrics.sh pr_summary
  • The relative value is the weighted sum of the differences with weight given by the inverse of the current value of the statistic.
  • The absolute value is the relative value divided by the total sum of the inverses of the current values (i.e. the weighted average of the differences).

@leanprover-community-bot-assistant leanprover-community-bot-assistant added the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Feb 11, 2025
@github-actions github-actions bot removed the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Feb 11, 2025
@leanprover-community-bot-assistant leanprover-community-bot-assistant added the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Feb 11, 2025
@github-actions github-actions bot removed the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Feb 11, 2025
Co-authored-by: Eric Wieser <[email protected]>
depsMap : Std.HashMap FilePath (Array FilePath) := ∅
/--
For modules in Mathlib or upstream, this contains the same information
as `hashMap`. Contains `none` if a source file couldn't be found.
Copy link
Member

Choose a reason for hiding this comment

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

Is it none only for source files not in mathlib?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

updated the docstring. Files downstream will fall into the latter category, but not necessarily exclusively.

E.g. if you'll write import Mathlib.Data in another mathlib file and try to get cache, this file will have none as Mathlib/Data.lean doesn't exist. (meaning no cache will be retrieved for the file with bad import)

Copy link
Member

@eric-wieser eric-wieser left a comment

Choose a reason for hiding this comment

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

bors d+

Thanks!

@mathlib-bors
Copy link
Contributor

mathlib-bors bot commented Feb 11, 2025

✌️ joneugster can now approve this pull request. To approve and merge a pull request, simply reply with bors r+. More detailed instructions are available here.

@joneugster
Copy link
Collaborator Author

bors r+

mathlib-bors bot pushed a commit that referenced this pull request Feb 12, 2025
@mathlib-bors
Copy link
Contributor

mathlib-bors bot commented Feb 12, 2025

Pull request successfully merged into master.

Build succeeded:

@mathlib-bors mathlib-bors bot changed the title doc(Cache/Hashing): add docstring for HashMemo [Merged by Bors] - doc(Cache/Hashing): add docstring for HashMemo Feb 12, 2025
@mathlib-bors mathlib-bors bot closed this Feb 12, 2025
@mathlib-bors mathlib-bors bot deleted the eugster/cache_cleanup_doc_hashMemo branch February 12, 2025 10:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
delegated documentation Improvements or additions to documentation easy < 20s of review time. See the lifecycle page for guidelines. t-meta Tactics, attributes or user commands
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants