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

Add and improve documentation #7

Closed
charleskawczynski opened this issue Aug 14, 2024 · 0 comments · Fixed by #11
Closed

Add and improve documentation #7

charleskawczynski opened this issue Aug 14, 2024 · 0 comments · Fixed by #11
Labels
documentation Improvements or additions to documentation

Comments

@charleskawczynski
Copy link
Member

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant