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.

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

✏️ [Documentation/Readme Enhancement] - <Update Natspec annotations for updated Contract Structure> #247

Closed
5 tasks
zaryab2000 opened this issue Jan 4, 2024 · 0 comments · Fixed by #263
Closed
5 tasks

✏️ [Documentation/Readme Enhancement] - <Update Natspec annotations for updated Contract Structure> #247

zaryab2000 opened this issue Jan 4, 2024 · 0 comments · Fixed by #263
Assignees
@Zartaj0
Labels
documentation Improvements or additions to documentation
Milestone
Push Core V2.5 (a...

Comments

@zaryab2000
Copy link
Collaborator

Expected Behaviour

Update Natspec Annotations for all the new contract files in the updated structure:

  • Core Interface
  • Comm Interface
  • DataTypes Files
  • Include Natspec for events as well
  • Modify Header Natspec for Core and Comm Files

Current Behaviour

Inadequate or outdated natspec in contract files

Steps to Reproduce

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See it
@zaryab2000 zaryab2000 added the documentation Improvements or additions to documentation label Jan 4, 2024
@Zartaj0 Zartaj0 mentioned this issue Jan 16, 2024
Merged
@Zartaj0 Zartaj0 linked a pull request Jan 16, 2024 that will close this issue
Improve nastpec docs #263
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Zartaj0 Zartaj0

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Push Core V2.5 (and Clean-Ups)
Development

Successfully merging a pull request may close this issue.

Improve nastpec docs push-protocol/push-smart-contracts
2 participants
@zaryab2000 @Zartaj0