8000 Docstrings for DePool, Oracle and stETH contracts · Issue #87 · lidofinance/core · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Docstrings for DePool, Oracle and stETH contracts #87

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

Jump to bottom
Closed
ongrid opened this issue Oct 22, 2020 · 0 comments · Fixed by #153
Closed

Docstrings for DePool, Oracle and stETH contracts #87

ongrid opened this issue Oct 22, 2020 · 0 comments · Fixed by #153
Assignees
@ongrid
Labels
documentation Improvements or additions to documentation polishing Style improvements
Milestone
RC2

Comments

@ongrid
Copy link
Contributor
ongrid commented Oct 22, 2020

All the libraries, contracts and functions should have relevant DoxygenStrings. Docs should follow the same style, describing the interface and purpose. Non-trivial math should be explained in detail. If the code was inherited or inspired, the link to the source should be provided.

Styling references:

@aragon/os/contracts/apps/AragonApp.sol
@aragon/os/contracts/lib/math/SafeMath.sol
@openzeppelin-solidity/contracts/token/ERC20/ERC20.sol
@ongrid ongrid added the documentation Improvements or additions to documentation label Oct 22, 2020
@ongrid ongrid added this to the RC1 milestone Oct 22, 2020
@ongrid ongrid self-assigned this Oct 22, 2020
@ongrid ongrid mentioned this issue Oct 22, 2020
Closed
ongrid added a commit that referenced this issue Oct 27, 2020
@ongrid
WIP: Add Solidity documentation #87
d6d4d63 
* Note on unstructured storage and positions
* Describe setDepositIterationLimit
* Describe getFee, getFeeDistribution
@ongrid ongrid modified the milestones: RC1, RC2 Oct 28, 2020
ongrid added a commit that referenced this issue Nov 4, 2020
@ongrid
WIP: Add Solidity documentation #87
4549132 
* Note on unstructured storage and positions
* Describe setDepositIterationLimit
* Describe getFee, getFeeDistribution
This was referenced Nov 11, 2020
Closed
Closed
@ongrid ongrid added the polishing Style improvements label Nov 15, 2020
ongrid added a commit that referenced this issue Nov 15, 2020
@ongrid
Add docstrings to Lido #87
0254ee2 
* Title description
* initialize() doxygen
* fallback and submit, _submit
* depositBufferedEther, _depositBufferedEther
* setOracle
* setDepositIterationLimit
* pushBeacon
* getBufferedEther
* getTotalPooledEther
* getToken
* getOracle
* setToken
* setValidatorRegistrationContract
* _setOperators
* _setDepositIterationLimit
* _ETH2Deposit, _stake, _submitted
* distributeRewards
* _getTransientBalance
lxzrv pushed a commit that referenced this issue Nov 17, 2020
@ongrid
Add docstrings to Lido #87
38f3d85 
* Title description
* initialize() doxygen
* fallback and submit, _submit
* depositBufferedEther, _depositBufferedEther
* setOracle
* setDepositIterationLimit
* pushBeacon
* getBufferedEther
* getTotalPooledEther
* getToken
* getOracle
* setToken
* setValidatorRegistrationContract
* _setOperators
* _setDepositIterationLimit
* _ETH2Deposit, _stake, _submitted
* distributeRewards
* _getTransientBalance
@ongrid ongrid mentioned this issue Nov 18, 2020
Merged
ongrid added a commit that referenced this issue Nov 22, 2020
@ongrid
Add docstrings to Lido #87
955934a 
* Title description
* initialize() doxygen
* fallback and submit, _submit
* depositBufferedEther, _depositBufferedEther
* setOracle
* setDepositIterationLimit
* pushBeacon
* getBufferedEther
* getTotalPooledEther
* getToken
* getOracle
* setToken
* setValidatorRegistrationContract
* _setOperators
* _setDepositIterationLimit
* _ETH2Deposit, _stake, _submitted
* distributeRewards
* _getTransientBalance
ongrid added a commit that referenced this issue Nov 22, 2020
@ongrid
Add docstrings to Lido #87
96a5d29 
* Title description
* initialize() doxygen
* fallback and submit, _submit
* depositBufferedEther, _depositBufferedEther
* setOracle
* setDepositIterationLimit
* pushBeacon
* getBufferedEther
* getTotalPooledEther
* getToken
* getOracle
* setToken
* setValidatorRegistrationContract
* _setOperators
* _setDepositIterationLimit
* _ETH2Deposit, _stake, _submitted
* distributeRewards
* _getTransientBalance
skozin pushed a commit that referenced this issue Nov 22, 2020
@ongrid @skozin
Add docstrings to Lido #87
acf7ed7 
* Title description
* initialize() doxygen
* fallback and submit, _submit
* depositBufferedEther, _depositBufferedEther
* setOracle
* setDepositIterationLimit
* pushBeacon
* getBufferedEther
* getTotalPooledEther
* getToken
* getOracle
* setToken
* setValidatorRegistrationContract
* _setOperators
* _setDepositIterationLimit
* _ETH2Deposit, _stake, _submitted
* distributeRewards
* _getTransientBalance
krogla pushed a commit that referenced this issue Jan 26, 2021
@ongrid
WIP: Add Solidity documentation #87
ad571b6 
* Note on unstructured storage and positions
* Describe setDepositIterationLimit
* Describe getFee, getFeeDistribution
krogla pushed a commit that referenced this issue Jan 26, 2021
@ongrid
Add docstrings to Lido #87
e0ea88f 
* Title description
* initialize() doxygen
* fallback and submit, _submit
* depositBufferedEther, _depositBufferedEther
* setOracle
* setDepositIterationLimit
* pushBeacon
* getBufferedEther
* getTotalPooledEther
* getToken
* getOracle
* setToken
* setValidatorRegistrationContract
* _setOperators
* _setDepositIterationLimit
* _ETH2Deposit, _stake, _submitted
* distributeRewards
* _getTransientBalance
dechjo pushed a commit to dechjo/lido-dao that referenced this issue Jan 26, 2021
@ongrid @skozin
Add docstrings to Lido lidofinance#87
d3b1f59 
* Title description
* initialize() doxygen
* fallback and submit, _submit
* depositBufferedEther, _depositBufferedEther
* setOracle
* setDepositIterationLimit
* pushBeacon
* getBufferedEther
* getTotalPooledEther
* getToken
* getOracle
* setToken
* setValidatorRegistrationContract
* _setOperators
* _setDepositIterationLimit
* _ETH2Deposit, _stake, _submitted
* distributeRewards
* _getTransientBalance
tamtamchik pushed a commit that referenced this issue Sep 30, 2024
@failingtwice
Merge pull request #87 from lidofinance/develop
65d6c6d 
Weekly PR: moving to yarn
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ongrid ongrid

Labels
documentation Improvements or additions to documentation polishing Style improvements
Projects
None yet
Milestone
RC2
Development

Successfully merging a pull request may close this issue.

LIP-3 Oracle interface and reward algorithm for v0.2.x lidofinance/core
1 participant
@ongrid
0