-
Notifications
You must be signed in to change notification settings - Fork 111
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
Hide sov-modules-macros
for all public APIs; re-export from sov-modules-api
#542
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
neysofu
added
documentation
Improvements or additions to documentation
usability
Something that makes it easier to use or operate Sovereign SDK
labels
Jul 21, 2023
neysofu
force-pushed
the
filippo/reexport-macros
branch
from
July 21, 2023 11:27
ddc7e52
to
884d417
Compare
neysofu
force-pushed
the
filippo/reexport-macros
branch
2 times, most recently
from
July 21, 2023 12:38
94be4c4
to
017f669
Compare
neysofu
force-pushed
the
filippo/reexport-macros
branch
from
July 21, 2023 13:59
017f669
to
5972a62
Compare
Codecov Report
|
bkolad
approved these changes
Jul 24, 2023
preston-evans98
pushed a commit
that referenced
this pull request
Sep 14, 2023
…dules-api` (#542) * Re-export macros for `sov-modules-api` * Remove direct use of `sov-modules-macros` * Update all docs * Fix intradoc links * Fix macros module doc comment & import * Fix all tests * Fix default features * Fix README code example
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
usability
Something that makes it easier to use or operate Sovereign SDK
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.
Description
My goal with this PR is to collect feedback –and not necessarily merge right away, unless feedback is positive– about a total removal of the
sov_modules_macros
from all public APIs. The less crates the user has to interact with, the better, from my POV; this pattern is also popular in well-regarded crates likeserde
.The current contents of the
sov-modules-macros
crates will get re-exported bysov-modules-api
as following:sov_modules_api
, which allows for importing the derive macro together with the trait.rpc_gen
,cli_parser
,DefaultRuntime
and all other proc macros (for which there's no homonymous trait) will be available undersov_modules_api::macros
.All of these will be gated by the
macros
feature flag.Testing
Relying on current tests. Doctests have been updated as necessary.
Docs
Examples and READMEs have been updated.