TOPIO/BigWhoop
TOPIO/BigWhoop
4
1
Fork 0
Code Issues 28 Pull requests Projects 6 Releases Packages Wiki Activity

Adapt the source code documentation to the new coding style #11

New issue
Open
opened 2023-06-20 12:58:02 +00:00 by Patrick Vogler · 0 comments
Patrick Vogler commented 2023-06-20 12:58:02 +00:00
Owner
Copy link

Summary

The new coding style is designed to allow the source code to be displayed on small terminal outputs (line width >= 100). To make sure the code is easily readable and small changes can be made on the terminal the source code documentation needs to be adapted to this output paradigm. It is also crucial that the documentation is unintrusive, easily maintainable and readable and doesn't hinder the coding work.

## Summary The new coding style is designed to allow the source code to be displayed on small terminal outputs (line width >= 100). To make sure the code is easily readable and small changes can be made on the terminal the source code documentation needs to be adapted to this output paradigm. It is also crucial that the documentation is unintrusive, easily maintainable and readable and doesn't hinder the coding work.
Patrick Vogler added this to the Revised source code documentation milestone 2023-06-20 12:58:02 +00:00
Patrick Vogler self-assigned this 2023-06-20 12:58:02 +00:00
Patrick Vogler added this to the Documentation project 2023-06-20 12:58:02 +00:00
Patrick Vogler removed their assignment 2024-04-09 11:16:33 +00:00
Sign in to join this conversation.
streaming
Branches Tags
Clear current reference
main
develop-gws
feat/api
docs/template
git/config
develop-pv
hipify
streaming
Clear current reference
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Revised source code documentation
Projects
Clear projects
No items
No project
Documentation
Assignees
Clear assignees
No assignees
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: TOPIO/BigWhoop#11
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?