Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #203 +/- ##
==========================================
+ Coverage 78.46% 85.51% +7.05%
==========================================
Files 196 86 -110
Lines 17953 11015 -6938
Branches 2100 1308 -792
==========================================
- Hits 14087 9420 -4667
+ Misses 3313 1303 -2010
+ Partials 553 292 -261 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Helveg
left a comment
There was a problem hiding this comment.
I don't like using class maps for generic strategy attributes, I mostly use them when the components that are being used represent some easily understood object or concept like a "layer", "cone", ... here your classmap is just the snake case of your class name, then to me that doesn't warrant using a classmap.
The documentation is good! Maybe cover even more cases and edge cases? The same ones that I've mentioned in the docstring.
If possible, I think all this information should go into the docstring? That way all the information is in 1 place. I'm not sure I am in favor of maintaining separate lists of component explanations anymore (we did that in BSB2&3 and it was always very poorly maintained and incomplete). If we make the docstring a complete documentation then the information about the class isn't spread out in multiple places.
|
I will improve the docstrings and and add some examples in the documentation. But i think that to move all the documentation in the docstrings will require a lot of refactoring (for instance the code / config snippets). |
|
I agree that including such extensive documentation into the docstring might require a bit too much rethinking of what you wrote, even though docstrings fully support RST iirc. This PR places a new link here (red rectangle), while I would rather place it as another domain (red stripe):
Like the other domains then the concept of post processing can be introduced, and your 2 explanations can be moved to their own "List of postprocessing hooks" the way the other domains do it. At least that way it's analog to what we have elsewhere and we can table the rest of the discussion for another time 😄 @drodarie do you agree we should add the postprocessing docs analogously the placement and connectivity domain docs? |
|
@Helveg, Yes we agree on the location of the |
|
Yes let's table that part for now! What I think important for the quality of the documentation for now is that:
Oh, also, explain how |
Helveg
left a comment
There was a problem hiding this comment.
Looks greeeaaaat!!! Here are some typos. I would recommend to pass all new documentation text through an LLM.
|
I made grammar check with Gemini, do not know why bsb-yaml doc is failing now... |
|
The docs failed randomly, I'm rebuilding them to double check. @drodarie this one is ready to merge :) |

Describe the work done
It is implemented a PostConnectivityHook that helps the user to merge chains of connectivity set.
The core class is FuseConnectivity that implement the logic for merging two connection tabels and the method create_connectivity_set that builds the connectivity tree of a list of connection provided and creates a new connectivity set for every root-leaf pair.
Two strategies are proposed:
List which issues this resolves:
closes #183
Tasks
📚 Documentation preview 📚: https://bsb--203.org.readthedocs.build/en/203/
📚 Documentation preview 📚: https://bsb-core--203.org.readthedocs.build/en/203/