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

Documentation support issues #202

Open
i582 opened this issue Oct 17, 2024 · 0 comments · May be fixed by #203
Open

Documentation support issues #202

i582 opened this issue Oct 17, 2024 · 0 comments · May be fixed by #203

Comments

@i582
Copy link
Contributor

i582 commented Oct 17, 2024

This issue will be used to store documentation support issues in the plugin:

  1. No documentation for elements with such layout (see also vector::pop_back):
    #[event]
    /// When `ObservedJWKs` is updated, this event is sent to resync the JWK consensus state in all validators.
    struct ObservedJWKsUpdated has drop, store {
        epoch: u64,
        jwks: AllProvidersJWKs,
    }
  2. Variables/parameters/type parameters hover documentation is not monospaced
  3. Empty hover documentation for spec fun spec_contains
  4. Not really valid documentation for AbortsIfNone
  5. Empty documentation for fun eq_push_back in spec module {}
@i582 i582 changed the title Documentation issues Documentation support issues Oct 18, 2024
@i582 i582 linked a pull request Oct 18, 2024 that will close this issue
3 tasks
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 a pull request may close this issue.

1 participant