Docs/354 extend general overview documentation #381
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…al overview in technical documentation
… a git-ignored directory
ArdtK
requested changes
Mar 25, 2024
There was a problem hiding this comment.
Few comments/questions.
Next to that I think we need to align on:
- Setup and naming of drawio files. Proposal:
- 1 diagram per file
- add scope of and type of diagram in the name (e.g.
ra2ce_network_class)
- Semantics of terms
package/subpackage/module:- ra2ce is a package
- everything else with an init.py (e.g. network, analysis, etc) is a subpackage
- single .py-files are modules
- from a business perspective an analysis is a module, although technically it can be implemented as a subpackage or module
Note that when you export as png with the option "Include a copy of my diagram" it can be used as source as well. This is much more efficient.
Closed
3 tasks
ArdtK
approved these changes
Mar 25, 2024
Co-authored-by: Ardt Klapwijk <59741981+ArdtK@users.noreply.github.com>
Carsopre
added a commit
that referenced
this pull request
Apr 12, 2024
…w-documentation Docs/354 extend general overview documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.