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

[Feature] Better Rust Docs #1213

Open
1 of 16 tasks
gluax opened this issue Jul 29, 2021 · 1 comment
Open
1 of 16 tasks

[Feature] Better Rust Docs #1213

gluax opened this issue Jul 29, 2021 · 1 comment
Labels
feature A new feature. priority-medium A medium priority bug/task in Leo.

Comments

@gluax
Copy link
Contributor

gluax commented Jul 29, 2021

🚀 Feature

We should have better Rust Docs for Leo and its sub-crates.

Motivation

For clearer developer documentation.
We should also set up a GitHub Pages to host the master branch version, for the sake of convenience for developers(it should be free).

We should add the clippy flag #![deny(clippy::all, clippy::missing_docs_in_private_items)] to our rust format configuration so this is enforced.

For now, while this rust cargo issue or this clippy issue is not implemented, we should add that line to each package's lib/entry point file.

Implementation

Go comment on all the things.

  • asg-passes
  • asg
  • ast
  • compiler
  • errors
  • examples
  • imports
  • input
  • leo
  • linter
  • package
  • parser
  • state
  • synthesizer
  • test-framework
  • tests
@gluax gluax added feature A new feature. priority-medium A medium priority bug/task in Leo. labels Jul 29, 2021
@collinc97 collinc97 added priority-low A low priority bug/task in Leo. and removed priority-medium A medium priority bug/task in Leo. labels Feb 16, 2022
@collinc97
Copy link
Collaborator

Marking this as priority low until after testnet3 refactor

@collinc97 collinc97 added priority-medium A medium priority bug/task in Leo. and removed priority-low A low priority bug/task in Leo. labels Jan 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature A new feature. priority-medium A medium priority bug/task in Leo.
Projects
None yet
Development

No branches or pull requests

3 participants