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

doc: update user widget manual #5006

Merged
merged 2 commits into from
Aug 23, 2024
Merged

Conversation

Vtec234
Copy link
Member

@Vtec234 Vtec234 commented Aug 12, 2024

Updates the user widget manual to account for more recent changes. One issue is that the samples no longer work on https://live.lean-lang.org/ because it uses an outdated version of the @leanprover/infoview NPM package. They work on https://lean.math.hhu.de/ and in recent versions of the VSCode extension.

Registers `[builtin_widget_module]` and `[widget_module]` and binds the latter's implementation
(used for creating the obsolete `[widget]` alias below).
-/
/-- Registers a widget module. Its type must implement `Lean.Widget.ToModule`. -/
Copy link
Member Author

Choose a reason for hiding this comment

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

Moved implementation detail below because the docstring is what's shown in hovers.

@Vtec234 Vtec234 changed the title Update user widget manual doc: update user widget manual Aug 12, 2024
@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 Aug 12, 2024
@leanprover-community-mathlib4-bot
Copy link
Collaborator

Mathlib CI status (docs):

  • ❗ Batteries/Mathlib CI will not be attempted unless your PR branches off the nightly-with-mathlib branch. Try git rebase 7cd406f335db0b3ba02fc52b36362b49e6118983 --onto 5f31e938c1bf5bb2d6d2d29b26ea932ade115357. (2024-08-12 20:21:44)

@Vtec234 Vtec234 added this pull request to the merge queue Aug 23, 2024
Merged via the queue into leanprover:master with commit 2bc8729 Aug 23, 2024
13 of 14 checks passed
@Vtec234 Vtec234 deleted the widget-manual branch August 23, 2024 20:10
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.

2 participants