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

[Bridge] [Warnings] when compiling/testing Move module atomic_bridge #89

Open
franck44 opened this issue Nov 7, 2024 · 1 comment · May be fixed by #92
Open

[Bridge] [Warnings] when compiling/testing Move module atomic_bridge #89

franck44 opened this issue Nov 7, 2024 · 1 comment · May be fixed by #92
Assignees
@franck44
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@franck44
Copy link

franck44 commented Nov 7, 2024

Problems

Compiling, testing or proving the Move contract atomic_bridge.move generates several warnings.

  • some are related to import of unused packages
    warning: unused alias ┌─ /Users/franck/development/mvntlabs-aptos-core/aptos-move/framework/aptos framework/sources/atomic_bridge.move:529:26 │ 529 │ use aptos_framework::atomic_bridge_configuration; │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Unused 'use' of alias 'atomic_bridge_configuration'. Consider removing it
  • some to documentation that is not properly positioned.
    warning: invalid documentation comment ┌─ /Users/franck/development/mvntlabs-aptos-core/aptos-move/framework/aptos-framework/sources/atomic_bridge.move:831:5 │ 831 │ /// Gets initiator bridge transfer details given a bridge transfer ID │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Documentation comment cannot be matched to a language item

Fixes

  • for unused import warnings use #[test_only] when module is only used in tests
  • for documentation, swap documentation /// this is the doc and the attribute [#view] (attribute comes before doc).
@franck44 franck44 added bug Something isn't working documentation Improvements or additions to documentation labels Nov 7, 2024
@franck44 franck44 changed the title [Warnings] when compiling/testing Move module atomic_bridge [Bridge] [Warnings] when compiling/testing Move module atomic_bridge Nov 7, 2024
@franck44 franck44 self-assigned this Nov 7, 2024
franck44 added a commit that referenced this issue Nov 7, 2024
@franck44
Swap order of doc and attributes. see #89
833a732
franck44 added a commit that referenced this issue Nov 7, 2024
@franck44
Add attribute #[test_only] to module only used in test. Fixes #89
fc7867d
@andygolay
Copy link

andygolay commented Nov 7, 2024 •
edited
Loading

I already created a PR for this, #88.

No problem if we want to merge your PR #92 instead as it also includes a .gitignore update.

@andyjsbell andyjsbell linked a pull request Nov 7, 2024 that will close this issue
Issue89/bridge warnings when compiling testing move module atomic bridge #92
Open
21 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@franck44 franck44

Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Issue89/bridge warnings when compiling testing move module atomic bridge movementlabsxyz/aptos-core
2 participants
@franck44 @andygolay