Skip to content

docs: add NatSpec comment explaining Milady.sol #1520

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.

Sign up for GitHub

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

Open
xu-nicolas wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −0
Open

docs: add NatSpec comment explaining Milady.sol #1520

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/Milady.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,19 @@ import "./utils/UpgradeableBeacon.sol";
import "./utils/WebAuthn.sol";
import "./utils/ext/delegatexyz/DelegateCheckerLib.sol";

/// @title Milady - A Solady Facade for Rapid Prototyping
/// @notice This is a convenience "facade" file that imports all modules of the
/// solady library. This allows for rapid prototyping by enabling a single
/// import statement to access the entire library:
///
/// ```
/// import "solady/Milady.sol";
/// ```
///
/// For production deployments, it is recommended to import only the specific
/// modules you need to minimize bytecode size.
///
/// The Milady library also contains constants for the Milady Maker ecosystem.
library Milady {
string internal constant WEBSITE = "https://miladymaker.net";

Expand Down