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

💡 [REQUEST] - Inherit base contract docs @inheritdoc in LSP #370

Open
michprev opened this issue Jan 25, 2025 · 0 comments
Open

💡 [REQUEST] - Inherit base contract docs @inheritdoc in LSP #370

michprev opened this issue Jan 25, 2025 · 0 comments
Labels
good first issue Good for newcomers

Comments

@michprev
Copy link
Member

Summary

Show the base contract docs instead of

/// @inheritdoc IPool

in LSP hover.

Basic Example

Instead of

    /// @inheritdoc IPool

show

    /**
     * @notice Function to liquidate a non-healthy position collateral-wise, with Health Factor below 1
     * - The caller (liquidator) covers `debtToCover` amount of debt of the user getting liquidated, and receives
     *   a proportionally amount of the `collateralAsset` plus a bonus to cover market risk
     * @param collateralAsset The address of the underlying asset used as collateral, to receive as result of the liquidation
     * @param debtAsset The address of the underlying borrowed asset to be repaid with the liquidation
     * @param user The address of the borrower getting liquidated
     * @param debtToCover The debt amount of borrowed `asset` the liquidator wants to cover
     * @param receiveAToken True if the liquidators wants to receive the collateral aTokens, `false` if he wants
     * to receive the underlying collateral asset directly
     */

Drawbacks

None

Unresolved questions

What is the devdoc contains more text lines and @inheritdoc is just one of them?

Implementation PR

No response

Reference Issues

No response

@michprev michprev added the good first issue Good for newcomers label Jan 25, 2025
@michprev michprev changed the title 💡 [REQUEST] - Inherit base contract docs inheritdoc in LSP 💡 [REQUEST] - Inherit base contract docs @inheritdoc in LSP Jan 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant