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.

Sign up for GitHub

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

Jump to bottom

Documentation #14

Open
1 of 14 tasks
pixelcmtd opened this issue Apr 9, 2022 · 1 comment
Open
1 of 14 tasks

Documentation #14

pixelcmtd opened this issue Apr 9, 2022 · 1 comment
Labels
accemus Relates to the `accemus` tool. documentation Improvements or additions to documentation dsb Relates to the `dsb` package that deals with DSBMobile. dsbuntis Relates to the `dsbuntis` package that pulls everything together. untis Relates to the `untis` package that deals with Untis parsing.

Comments

@pixelcmtd
Copy link
Member

pixelcmtd commented Apr 9, 2022 •
edited
Loading

None of the code currently has any dart doc comments. The READMEs have also become less informative during splitting (#11). Both of these issues should be addressed very shortly after the initial dsbuntis 8.0.0 release.

What's to-do:

  • dsb README
  • dsb getting_started.md
  • dsb example code
  • dsb dart doc
  • untis README
  • untis getting_started.md
  • untis example code
  • untis dart doc
  • dsbuntis README
  • dsbuntis getting_started.md
  • dsbuntis example code
  • dsbuntis dart doc
  • accemus @tldr-pages page
  • accemus README
@pixelcmtd pixelcmtd added documentation Improvements or additions to documentation dsb Relates to the `dsb` package that deals with DSBMobile. untis Relates to the `untis` package that deals with Untis parsing. dsbuntis Relates to the `dsbuntis` package that pulls everything together. labels Apr 9, 2022
@pixelcmtd pixelcmtd changed the title Dart Doc and rewriting READMEs Documentation Apr 10, 2022
@pixelcmtd
Copy link
Member Author

I think it would be nice, if we could get through most, if not all of this for the dsb 0.1.1 / untis 0.2.0 / dsbuntis 8.1.0 / accemus 0.2.1 release cycle, since we basically, as of now at least, got infinite time, as there are no known bugs that need to be fixed quickly.

@pixelcmtd pixelcmtd added the accemus Relates to the `accemus` tool. label May 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
accemus Relates to the `accemus` tool. documentation Improvements or additions to documentation dsb Relates to the `dsb` package that deals with DSBMobile. dsbuntis Relates to the `dsbuntis` package that pulls everything together. untis Relates to the `untis` package that deals with Untis parsing.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pixelcmtd