Skip to content

Add and improve documentation #7

@charleskawczynski

Description

@charleskawczynski

xref:

  • the problem that the package solves is not clearly identified
  • it assumes that the reader has specialized knowledge of how Brocasted objects work and how to use them
  • the only example provided is a test case which comes with no explanation and components that are not pedagogically useful (all the Test related stuff)
  • it is not explained how one would use bce or bco
  • the difference between bce and bco is left to the reader to understand
  • the fact that the package has restrictions is not mentioned
  • it does not guide the reader to further documentation, so the way I find myself trying to figure things out is by browsing the testcases

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions