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

Definition rendering fixes #38

Merged
merged 6 commits into from
Feb 13, 2025
Merged

Definition rendering fixes #38

merged 6 commits into from
Feb 13, 2025

Conversation

ChrisPenner
Copy link
Contributor

@ChrisPenner ChrisPenner commented Feb 13, 2025

Overview

Share wouldn't find docs for definitions in Lib if they were linked via a hash, this fixes that.

Also, use suffixified names for self-references in types and abilities

Also, render abilities on two lines, always.

Implementation notes

We first search for the name via the hash, then we re-scope the doc search to wherever the name was found, even if that's in a lib.

Also updates the ucm version used in CI and updates transcripts to match.

Test coverage

  • tested locally

@ChrisPenner ChrisPenner changed the title Ensure we find docs when looking up terms by hash, even in lib Definition rendering fixes Feb 13, 2025
@ChrisPenner ChrisPenner marked this pull request as ready for review February 13, 2025 17:21
@ChrisPenner ChrisPenner requested a review from a team as a code owner February 13, 2025 18:01
@@ -52,7 +52,11 @@
},
{
"annotation": null,
"segment": " "
"segment": "\n"
Copy link

Choose a reason for hiding this comment

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

do we know why this changed?

Copy link
Contributor Author

@ChrisPenner ChrisPenner Feb 13, 2025

Choose a reason for hiding this comment

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

Yup; I added a manual break in ability pretty-printing;

Previously:

ability Blah where foo : Nat -> Nat

Now:

ability Blah where
  foo : Nat -> Nat

@ChrisPenner ChrisPenner merged commit b84dc2e into main Feb 13, 2025
4 checks passed
@ChrisPenner ChrisPenner deleted the cp/fix-hq-docs branch February 13, 2025 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants