[Docs] Link render issue of contract comment
xieyuschen opened this issue · 1 comments
Hi maintainers, i'm new to the sol and its documentation management, and i got a link rendered wrongly when either reading from the floating window or the code directly, as the images showed below. Once clicking the link, it will jump to site: https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How which is 404.
I'm not sure why we combine the title and the link together without any space. But I believe this might be an mimor issue due as it cannot be rendered properly in the floated window as well. Please correct me if there are some misunderstandings.
Regards
Hello @xieyuschen
This format is used by the doc generation system. The outcome is visible here: https://docs.openzeppelin.com/contracts/5.x/api/token/erc20#ERC20.
I'm sorry your IDE is not processing links the same way, but you'll understand that the generation of the official doc takes priority over support by a variety of IDE/plugins that won't reach consensus anyway.