-
Notifications
You must be signed in to change notification settings - Fork 28
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
Refactor module structure #237
Open
PoignardAzur
wants to merge
14
commits into
main
Choose a base branch
from
refactor_modules
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
Move data types to their respective modules
PoignardAzur
changed the title
[WIP] Refactor module structure
Refactor module structure
Dec 22, 2024
I think this is ready to merge. I'd recommend reviewing the commits individually otherwise this is a lot to take in at once. |
To be clear, this is a first stab at sorting parley's files differently. Follow-up PRs should:
|
I think this is blocked (at least) pending a comment from @dfrg … |
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.
This echoes a discussion I had with Chad a few weeks ago. Parley's current structure de-facto splits into three types of items:
(EDIT: There's also data structures for text editing which are mostly separate from the rest.)
This PR makes these four blocs into explicit modules, which should make both the code and the documentation much easier to read.
This should also help people navigate the upcoming refactor; algorithms will be changed radically, input types may be changed, output types are likely to stay the same. Explicitly marking them should make parallel work easier.
Another thing the PR does in de-tangle layout types. Currently, when you're looking for Cluster, do you find it in
cluster.rs
? Nope,layout/mod.rs
. What aboutClusterData
?layout/data.rs
. Splitting these types into their eponymous files makes them easier to find without IDE assistance.