Skip to content

Updating and formatting the docs #128

@elichai

Description

@elichai

I think some modules are underdocumented.
I think some of the docs deserves a redo and at least these are missing:

  • How to use the preallocated structs.
  • Explanations around the traits/enums.
  • Doing something with the fact that ffi is public but shows docs for the fuzzings functions.
  • Fixing failed attempts to bold text (i.e. in the Context trait and in Error::InvalidTweak)
  • Adding some explanation in the Secp256k1 struct about the different situation of different functions for different types of contexts (is there a way in rust docs to make it look a bit better?)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions