Skip to content

API reference docs problems #234

Open

Description

@Kircheneer

I see a couple of problems with the API docs:

  • The API reference wraps in the middle of the page
  • Code snippets don't use monospace
  • Not all return types exist in the function signature and sometimes they are manually added in the docstring (Type hinting overhaul. #219)

Activity

  1. cardoe commented on Nov 6, 2023

    @cardoe

    The docs reference _identifiers, _shortname, and _attributes as lists (see: https://diffsync.readthedocs.io/en/latest/getting_started/index.html#define-your-model-with-diffsyncmodel) but they're actually implemented as tuples. But then when you read how they're used, you really want them to be sets (maybe ordered sets if you really want to preserve that order).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions