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

Functor docstrings #1726

Merged
merged 2 commits into from
Aug 13, 2024
Merged

Functor docstrings #1726

merged 2 commits into from
Aug 13, 2024

Conversation

glguy
Copy link
Member

@glguy glguy commented Aug 13, 2024

Fix docstring behaviors around functors

  • Don't duplicate docstrings onto modules generated by the desugarer
  • Combine docstrings when instantiating a functor to preserve both the instance and the instantiated documentation

Suppresses extraneous :check-docstring output

Avoids printing definition names in a way that labels them as submodules

Fixes #1723

- Don't duplicate docstrings onto modules generated by the desugarer
- Combine docstrings when instantiating a functor to preserve both the instance and the instantiated documentation
@glguy glguy merged commit 1f6f880 into master Aug 13, 2024
48 checks passed
@glguy glguy deleted the functor-docstrings branch August 13, 2024 18:23
@glguy glguy self-assigned this Aug 13, 2024
RyanGlScott pushed a commit to GaloisInc/saw-script that referenced this pull request Aug 30, 2024
Cryptol - 3.2
Crucible - Crux v0.9
llvm-pretty - 0.12.1
llvm-pretty-bc-parser - 0.4.2

Bumping the Cryptol submodule requires a minor code change to accommodate
`Module`'s new `mDocTop` field (introduced in
GaloisInc/cryptol#1726).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Duplicated docstrings in instantiations with where
1 participant