Refactor fn_macros to rune-macros #44
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
The reasoning behind this is that this is the start of the modularization of the general crate, where I'm following the examples structure of some famous crates: axum (library) and ripgrep (binary). Axum has an `axum` preffix behind all the crates its main packages uses, so thought it would be beneficial to do the same. Also, moved rune-macros (renamed) inside `crates`, as it's a crate we depend on, and we already had one there. It's a good practice to list the members of the workspace directly, instead of using the wildcard, to avoid accidential build inclusion.
|
For the CI, I don't quite understand why |
|
it broke because we moved the new crate after the |
|
Damn, that was a surprise. Thanks! |
|
Thank you! This looks great. |
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.
Change Summary
The reasoning behind this is that this is the start of the modularization of the general crate, where I'm following the examples structure of some famous crates: axum (library) and ripgrep (binary). Axum has an
axumpreffix behind all the crates its main packages uses, so thought it would be beneficial to do the same.Also, moved rune-macros (renamed) inside
crates, as it's a crate we depend on, and we already had one there. It's a good practice to list the members of the workspace directly, instead of using the wildcard, to avoid accidential build inclusion.Lastly, added documentation to the
rune-macroscrate, to make sure that other contributors can check the crate and understand its usage from the documentation. Haven't documentedTracesince I'm not totally sure of what we want to include there or the usage ofTrace. Please, document it in another commit.Risks associated with this change
None that I think of.
Testing
cargo dochas the right output, links are correct. For the future, REVIEW: we can add CI for cargo doc running on the crates we plan to refactor:rune-core,rune-macrosand others. We'll see CI as part of this PR.