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.

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

Documentation... and refactoring #517

Merged
merged 23 commits into from
Apr 5, 2024
Merged

Documentation... and refactoring #517

merged 23 commits into from
Apr 5, 2024

Conversation

BenoitJeanson
Copy link
Contributor

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce?
The initial goal was to document the PositionFinder implementation (PositionFromExtension and PositionByClustering).
By doing so, reading in details this pieces of code, some refactoring were implemented.
The history was rebuilt (rebase -i) to reduce the number of commits, and it should be easier to review per commit rather than as a whole: the rebase is not perfect, some commit should have been split. That's why, I could not really separate documentation commits from Refactoring ones.
I recommend to review the Refactor commits one by one, and to review the documentation as whole.

  • Refactor : Simplify LegBusSet: this was already reviewed in a previous PR Simplify LegBusSet #502 and the comments were taken into account
  • Refactor : renaming of LegBusSet/HorizontalBusLane/LBSCluster to VerticalBusSet/HorizontalBusSet/BSCluster : The idea was to have a coherent vocabulary. Note that 4 commits later HorizontalBusSet became HorizontalBusList.
  • Refactor: create layout.positionprocessor subpackage and fill it in: new package to separate the PositionFinder implementations from the rest of the layout package. Note that 5 commits later, after discussion with the project group, this sub package was renamed in position
  • Refactor: Clarify PositionFinder interface by transferring some of particulars methods to AbstractPositionFinder: PositionFinder had methods that were really specific to the actual implementations, but not really required to make the job. So these methods were moved to AbstractPositionFinder. Some renaming to better reflect the renaming implemented in the previous commit were also done.
  • Documentation: update documentation on position package: Only documentation.
  • Refactor & Documentation: rename HorizontalBusSet into HorizontalBusList: Only renaming, but mixing code and documentation... ugly :-(
  • Refactor: tiny reorganization PositionFromExtension: a bit more than just a "tiny reorganization". Some move of code, and the HorizontalBusListManager interface is now directly implemented by PositionFromExtension and PositionByClustering which should reduce the complexity...
  • Refactor: Rename subpackage positionprocessor into position: and nothing more
  • Refactor: Rename VBSClusterSide in BSClusterSide: that was forgotten, and a bit of cleaning of an unused/useless method.
  • Refactor : Remove cyclic dependency between Links and BSClusterSide: and that simplifies the code.
  • Documentation : update doc: only doc
  • Merge with main!

Signed-off-by: Sophie Frasnedo <[email protected]>
@BenoitJeanson
Copy link
Contributor Author

I cannot fix the DCO. Each time I try to do what GitHub asks, it doubles the number of commits without fixing it. HELP!!

@BenoitJeanson BenoitJeanson force-pushed the Documentation2 branch 3 times, most recently from 34710c1 to 9f4a7bc Compare May 4, 2023 09:11
Signed-off-by: BenoitJeanson <[email protected]>

simplify LegBusSet

Signed-off-by: BenoitJeanson <[email protected]>

code smells

Signed-off-by: BenoitJeanson <[email protected]>

unused imports grrr

Signed-off-by: BenoitJeanson <[email protected]>

style

Signed-off-by: BenoitJeanson <[email protected]>

sonar

Signed-off-by: BenoitJeanson <[email protected]>

PR comment solved

Signed-off-by: BenoitJeanson <[email protected]>

PR comment solved

Signed-off-by: BenoitJeanson <[email protected]>

fix

Signed-off-by: BenoitJeanson <[email protected]>
…HorizontalBusSet/BSCluster

Signed-off-by: BenoitJeanson <[email protected]>

checkstyle

Signed-off-by: BenoitJeanson <[email protected]>
…methods to AbstractPositionFinder

Signed-off-by: BenoitJeanson <[email protected]>

remove unused imports

Signed-off-by: BenoitJeanson <[email protected]>

checkstyle

Signed-off-by: BenoitJeanson <[email protected]>

checkStyle again

Signed-off-by: BenoitJeanson <[email protected]>

remaining LegBusSet in a method name

Signed-off-by: BenoitJeanson <[email protected]>

cosmetic renaming

Signed-off-by: BenoitJeanson <[email protected]>

cosmetic renaming

Signed-off-by: BenoitJeanson <[email protected]>

Lbs still ! ... into Vbs

Signed-off-by: BenoitJeanson <[email protected]>

Cosmetic renaming

Signed-off-by: BenoitJeanson <[email protected]>

code smells

Signed-off-by: BenoitJeanson <[email protected]>
Signed-off-by: BenoitJeanson <[email protected]>

update documentation on position

Signed-off-by: BenoitJeanson <[email protected]>

cosmetic wording/typo

Signed-off-by: BenoitJeanson <[email protected]>
Signed-off-by: BenoitJeanson <[email protected]>

rename HorizontalBusSet into HorizontalBusList

Signed-off-by: BenoitJeanson <[email protected]>

rename HorizontalBusSet into HorizontalBusList

Signed-off-by: BenoitJeanson <[email protected]>
Signed-off-by: BenoitJeanson <[email protected]>

checkstyle

Signed-off-by: BenoitJeanson <[email protected]>

simplification of HBLManagerByExtension

Signed-off-by: BenoitJeanson <[email protected]>

Simplify by merging HorizontalBusLaneManager implementations into PositionFinder implementations

Signed-off-by: BenoitJeanson <[email protected]>
Signed-off-by: BenoitJeanson <[email protected]>

remove BSCluster::hasSameRoot (ghost from the past)

Signed-off-by: BenoitJeanson <[email protected]>

Rename VBSClusterSide in BSClusterSide

Signed-off-by: BenoitJeanson <[email protected]>
Signed-off-by: BenoitJeanson <[email protected]>

update docu

Signed-off-by: BenoitJeanson <[email protected]>

Detail PositionFromExtension.adoc

Signed-off-by: BenoitJeanson <[email protected]>

Detail PositionFromExtension.adoc

Signed-off-by: BenoitJeanson <[email protected]>

PositionByClustering documentation progress

Signed-off-by: BenoitJeanson <[email protected]>

Update documentation on position package

dead link

Signed-off-by: BenoitJeanson <[email protected]>
Signed-off-by: BenoitJeanson <[email protected]>
@sonarqubecloud
Copy link

sonarqubecloud bot commented May 5, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 1 Code Smell

93.8% 93.8% Coverage
0.0% 0.0% Duplication

@flo-dup flo-dup force-pushed the main branch 2 times, most recently from 1a28286 to 0248753 Compare June 7, 2023 15:43
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 1 Code Smell

93.8% 93.8% Coverage
0.0% 0.0% Duplication

@So-Fras So-Fras added the v4.3.0 label Jan 30, 2024
@So-Fras So-Fras removed the v4.3.0 label Apr 2, 2024
@So-Fras So-Fras added the SLD label Apr 4, 2024
Signed-off-by: Florian Dupuy <[email protected]>
Copy link

sonarqubecloud bot commented Apr 5, 2024

@flo-dup flo-dup merged commit 6b08e09 into main Apr 5, 2024
6 checks passed
@flo-dup flo-dup deleted the Documentation2 branch April 5, 2024 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants