Skip to content
This repository was archived by the owner on May 16, 2024. It is now read-only.
This repository was archived by the owner on May 16, 2024. It is now read-only.

Add doc blocks and specs to functions defined by XDR.Base #14

@grossvogel

Description

@grossvogel

I'm submitting a ...

  • bug report
  • feature request
  • support request

What is the current behavior?

Right now, if you import XDR.Base in your own module, you get a bunch of functions defined in your module for you, but only the delegated functions have doc blocks and specs, being inherited from XDR. The other functions are the important ones since they behave slightly different from what you can get out of XDR... because they deal with custom types in some way.

What is the expected behavior?

If a module extends XDR.Base, all of the functions defined thereby should have nice documentation. All we really need to do is add doc blocks and type specs to the defs inside __before_compile__ here.

Care should be taken to make sure these are really useful docs b/c this is going to be the main way a consumer (e.g. the Stellar client) interacts with XDR.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions