Skip to content

Commit b7dbec6

Browse files
committed
Improve documentation
1 parent d7b7846 commit b7dbec6

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

AUTHORS

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,18 @@ All rights reserved.
44
Lead Developers:
55
- Johannes Hiry
66
- Chris Kittl
7+
- Debopama Sen-Sarma
78

89
Main Contributers:
910
- Johannes Hiry - https://github.com/johanneshiry
1011
- Chris Kittl - https://github.com/ckittl
12+
- Debopama Sen-Sarma - https://github.com/sensarmad
1113
- Mia Krause - https://github.com/mia-krause
1214
- Dennis Strehle - https://github.com/denstre
15+
- Sebastian Peter - https://github.com/sebastian-peter
16+
- Christian Mahr - https://github.com/cmahr93
1317

1418
Coordination:
1519
- Chris Kittl
16-
- Johannes Hiry
20+
- Johannes Hiry
21+
- Debopama Sen-Sarma

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ most of the commonly known power flow calculations
2424
- Additional constructors based on lists of entities in ``RawGridElements``, ``SystemParticipants`` and ``GraphicElements``
2525
- Added ``DistanceWeightedGraph`` + corresponding utility method to generate a graph topology whose vertices are `NodeInput` entities and its edges are weighted with the distance between the vertices in meter
2626
- Added ``ContainerNodeUpdateUtil`` to support updating nested nodes in ``GridContainer`` instances
27+
- Gradle task `gradle finalizePR` to format and test the code as well as generate JavaDoc
2728

2829
### Changed
2930
- Disabled concurrent writing in `CsvFileSink.persistJointGrid()` as this caused concurrency issues
@@ -32,6 +33,7 @@ coordinates or multiple exactly equal coordinates possible
3233
- Extended functionality of `GridAndGeoUtils`
3334
- `CsvFileConnector` is now set up to process either UniqueEntities or only by file name
3435
- `SwitchResult` superclass changed from `ConnectorResult` to `ResultEntity`
36+
- Consolidate test tasks. `gradle allTests` is now replaced by `gradle test`. Only unit tests can be run with `gradle unitTest`.
3537

3638
### Fixed
3739
- CsvDataSource now stops trying to get an operator for empty operator uuid field in entities

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,9 @@ Before marking the pull request as 'ready to review', take these precautionary a
6363

6464
* Are all tests passing? Run `gradle test`
6565
* Is your code properly formatted? Run `gradle spotlessApply`
66-
* Update the javadoc pages. Run `gradle genJavadoc`
66+
* Update the javadoc pages. Run `gradle javadoc`
67+
68+
`gradle finalizePR` summarizes all of these steps .
6769

6870
## For any doubts
6971
... please contact

0 commit comments

Comments
 (0)