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

Documentation does not link functions from @openzeppelin/contracts #30

Open
ernestognw opened this issue Nov 29, 2024 · 0 comments
Open

Comments

@ernestognw
Copy link
Member

Description

The documentation API reference is automatically generated based on the vanilla contracts script. This causes the documentation to generate references that aren't available in this repository.

image

To avoid this issue naively, I implemented a quick fix to render the names without the reference.

Also, it doesn't solve references written in the documentation text itself:

image

Perhaps we can easily fix this second issue by linking to the OpenZeppelin documentation URL as we don't expect it to change until 6.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant