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

chore: Resolve various rustdoc warnings #7724

Merged
merged 3 commits into from
Mar 14, 2025
Merged

chore: Resolve various rustdoc warnings #7724

merged 3 commits into from
Mar 14, 2025
+41 −35

Conversation

vezenovm
Copy link
Contributor

@vezenovm vezenovm commented Mar 14, 2025 •
edited
Loading

Description

Problem*

No issue, part of general documentation drive

Summary*

I was generating docs locally with cargo doc. Resolving a bunch of various warnings.

One example of an issue that currently exists: text such as Tree is seen as an unclosed html tag. It needs to be wrapped in a source code block Tree<T>. In this case it caused unnecessary underlining:
Screenshot 2025-03-14 at 3 58 16 PM

Additional Context

Documentation*

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [For Experimental Features] Documentation to be submitted in a separate PR.

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@vezenovm vezenovm requested a review from a team March 14, 2025 20:01
vezenovm and others added 2 commits March 14, 2025 16:18
@vezenovm @TomAFrench
Update compiler/noirc_frontend/src/elaborator/traits.rs
e22c0f6 
Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
@vezenovm @TomAFrench
Update compiler/noirc_frontend/src/graph/mod.rs
6c160cf 
Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
@vezenovm vezenovm enabled auto-merge March 14, 2025 20:19
@vezenovm vezenovm added this pull request to the merge queue Mar 14, 2025
Merged via the queue into master with commit 51c68c8 Mar 14, 2025
104 of 105 checks passed
@vezenovm vezenovm deleted the mv/rustdoc-warnings branch March 14, 2025 20:58
TomAFrench added a commit that referenced this pull request Mar 14, 2025
@TomAFrench
Merge branch 'master' into tf/pull-out-get-all-contracts
b36603c 
* master:
  chore: add timeouts to CI (#7725)
  chore: Resolve various rustdoc warnings (#7724)
  chore: encapsulate `Index` within `LocalModuleId` (#7719)
  fix: doc comments on functions warn unexpectedly (#7721)
  chore: update docusaurus config to correct trailing slash issue (#7720)
  feat: allow `fn` returning `()` without having to write `-> ()` (#7717)
  fix: allow omitting ';' after last block statement if it's an assignment (#7718)
  chore: fix rustdoc issues (#7712)
  chore: check test program execution success output (#7713)
  chore: remove ultraplonk tests (#7680)
  chore(docs): Document BlackBoxFuncCall enum (#7702)
@AztecBot AztecBot mentioned this pull request Mar 15, 2025
Merged
TomAFrench added a commit to AztecProtocol/aztec-packages that referenced this pull request Mar 18, 2025
@TomAFrench @AztecBot
chore: bump noir (#12760)
e9526cf 
Automated pull of nightly from the
[noir](https://github.com/noir-lang/noir) programming language, a
dependency of Aztec.
BEGIN_COMMIT_OVERRIDE
chore(docs): Brillig opcodes
(noir-lang/noir#7722)
chore: add lambda calculus test
(noir-lang/noir#7646)
chore: bump external pinned commits
(noir-lang/noir#7728)
chore: pull most logic from `get_all_contracts` up out of the
`CrateDefMap` (noir-lang/noir#7715)
chore: add timeouts to CI (noir-lang/noir#7725)
chore: Resolve various rustdoc warnings
(noir-lang/noir#7724)
chore: encapsulate `Index` within `LocalModuleId`
(noir-lang/noir#7719)
fix: doc comments on functions warn unexpectedly
(noir-lang/noir#7721)
chore: update docusaurus config to correct trailing slash issue
(noir-lang/noir#7720)
feat: allow `fn` returning `()` without having to write `-> ()`
(noir-lang/noir#7717)
fix: allow omitting ';' after last block statement if it's an assignment
(noir-lang/noir#7718)
chore: fix rustdoc issues (noir-lang/noir#7712)
chore: check test program execution success output
(noir-lang/noir#7713)
chore: remove ultraplonk tests
(noir-lang/noir#7680)
chore(docs): Document BlackBoxFuncCall enum
(noir-lang/noir#7702)
chore: hide Ident fields (noir-lang/noir#7709)
chore(frontend): Regression test for creating a mutable reference to an
array element (noir-lang/noir#7699)
fix: wrong printing of line comment in quoted
(noir-lang/noir#7694)
chore: more descriptive SSA tests
(noir-lang/noir#7697)
chore(artifact_cli): Print circuit output to stdout
(noir-lang/noir#7696)
feat(ssa): Dominance frontiers
(noir-lang/noir#7692)
chore: add cargo deny advisory
(noir-lang/noir#7691)
chore: add workflow to publish rustdoc to github pages
(noir-lang/noir#7687)
fix: allow renaming a trait when importing it
(noir-lang/noir#7688)
chore: Update README.md to add trailing docs `/`
(noir-lang/noir#7689)
chore: add tests for trait renaming in imports
(noir-lang/noir#7631)
feat(ssa): Post dominator tree
(noir-lang/noir#7595)
chore(docs): Extend stable documentation versions to build to cover
multiple `beta.n` releases (noir-lang/noir#7685)
chore(docs): Minor fixes on local documentation development workflows
(noir-lang/noir#7684)
chore: add trailing slash to link on docs homepage
(noir-lang/noir#7682)
fix: allow referring to comptime locals at runtime
(noir-lang/noir#7681)
chore: easier way to test monormophization errors
(noir-lang/noir#7679)
chore(docs): update bb commands to match the new version
(noir-lang/noir#7677)
chore: update yarn version to 4.5.2
(noir-lang/noir#7678)
chore: migrate to use new flat eslint config file
(noir-lang/noir#7676)
chore: bump JS dependencies
(noir-lang/noir#7669)
chore: bump wasm-pack to 0.13.1
(noir-lang/noir#7675)
chore: bump node to v22.18.3
(noir-lang/noir#7668)
chore!: make `ResolverError::UnnecessaryPub` a hard error
(noir-lang/noir#7664)
fix: correctly format let followed by comment before unsafe
(noir-lang/noir#7659)
chore: bump external pinned commits
(noir-lang/noir#7667)
chore: fixing timeouts (noir-lang/noir#7666)
chore(ssa): Do not print entire functions in underconstrained values
check trace (noir-lang/noir#7665)
chore(ci): Exclude enum tests from Brillig reports
(noir-lang/noir#7661)
chore: add regression tests for PR #7570 from lambda interpreter test
(noir-lang/noir#7638)
chore: remove some unused HIR code
(noir-lang/noir#7643)
chore: update examples to use UltraHonk
(noir-lang/noir#7653)
fix: allow method call after block, if and match
(noir-lang/noir#7655)
chore: address recurring typo in docs
(noir-lang/noir#7656)
fix(ssa): don't check Brillig calls for coverage if they don't return
anything (e.g. println) (noir-lang/noir#7644)
END_COMMIT_OVERRIDE

---------

Co-authored-by: AztecBot <tech@aztecprotocol.com>
@AztecBot AztecBot mentioned this pull request Mar 18, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomAFrench TomAFrench TomAFrench approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@vezenovm @TomAFrench