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

[Feature] move sol! doctest descriptions out of the code #169

Closed
DaniPopes opened this issue Jul 2, 2023 · 0 comments · Fixed by #173
Closed

[Feature] move sol! doctest descriptions out of the code #169

DaniPopes opened this issue Jul 2, 2023 · 0 comments · Fixed by #173
Assignees
Labels
enhancement New feature or request

Comments

@DaniPopes
Copy link
Member

Component

sol-type, sol! macro

Describe the feature you would like

For rendering to markdown. Other inline comments and docs are fine.

Additional context

E.g.

This:

// Contracts generate a module with the same name, which contains all the items.
// This module will also contain 3 container enums, one for each:
// - functions: `<contract_name>Calls`
// - errors: `<contract_name>Errors`
// - events: `<contract_name>Events`
sol! {

To here:

/// ## Contracts/interfaces
/// ```ignore

@DaniPopes DaniPopes added the enhancement New feature or request label Jul 2, 2023
@DaniPopes DaniPopes self-assigned this Jul 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant