fsimphy/bayernfahrplan
4
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity

Create documentation #3

New issue
Closed
opened 2023-06-20 18:22:21 +02:00 by migration-script · 0 comments
migration-script commented 2023-06-20 18:22:21 +02:00
Copy link

Summary

The source code should be documented. ddoc should be used for that.

Description

As a developer, I want to be able to easily get an overview about how the program and its components work without needing to go through the sourcecode itself.

Acceptance criteria

Everything in the public interface should be documented. Examples should be given if applicable (possibly as unittests).

## Summary ## The source code should be documented. ddoc should be used for that. ## Description ## As a developer, I want to be able to easily get an overview about how the program and its components work without needing to go through the sourcecode itself. ## Acceptance criteria ## Everything in the public interface should be documented. Examples should be given if applicable (possibly as unittests).
migration-script added this to the 0.1 milestone 2023-06-20 18:22:21 +02:00
migration-script added the
doc
 label 2023-06-20 18:22:21 +02:00
saluu was assigned by migration-script 2023-06-20 18:22:21 +02:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
unit-threaded
release
v0.1.0
Labels
Clear labels   
doc

Related to the documentation

No labels
doc
Milestone
Clear milestone
No items
No milestone
0.1
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
saluu
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: fsimphy/bayernfahrplan#3
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?