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

Add docgen support for attributes (#7932) #8634

Closed
wants to merge 3 commits into from
Closed

Add docgen support for attributes (#7932) #8634

wants to merge 3 commits into from

Conversation

brmataptos
Copy link
Contributor

Add docgen support for attributes (e.g., #[view]) on Script, Module, Struct, and Fun (#7932)

Also fixed an unfiled bug in docgen that previously caused it to output docs for just a single Script/Module per input file.

Test Plan

Adapted existing attribute_placement.move test file and tested it with docgen. Rebuild with docs tested it on more input test cases, with updated .md outputs included in the second commit.

@brianrmurphy
Fix #7932
37e8300 
Docgen should output attributes (#7932).

Output attributes (e.g., #[view] or #[resource_group(scope = global)])
from docgen for move code.  Currently only handles attibutes on
Function, Script/Module, and Struct/Resource.

Note that attributes are allowed on some other syntactic objects
(address scope, use statement, const definition, spec), but how to
format these usefully in docgen is unclear.  for these in docgen is
unclear.

Also fix an unrelated bug discovered when adapting
attribute_placement.move as a test of docgen: previously, only a
single Module/Script per input file would be output in docgen.
@brianrmurphy
Update move library docs with new docgen.
c758a6a
@brmataptos brmataptos requested a review from saharct as a code owner June 13, 2023 00:33
@brmataptos brmataptos requested a review from wrwg June 13, 2023 00:33
@brmataptos brmataptos enabled auto-merge (squash) June 13, 2023 00:47
@brmataptos brmataptos changed the title Brianmurphy/docgen Add docgen support for attributes (#7932) Jun 13, 2023
@github-actions

This comment has been minimized.

Sign in to view
@github-actions

This comment has been minimized.

Sign in to view
@github-actions

This comment has been minimized.

Sign in to view
@github-actions
Copy link
Contributor

✅ Forge suite compat success on testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 0a8b95c58d036bec1f175aa5b95ca91fc3c8695a

Compatibility test results for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 0a8b95c58d036bec1f175aa5b95ca91fc3c8695a (PR)
1. Check liveness of validators at old version: testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b
compatibility::simple-validator-upgrade::liveness-check : committed: 8633 txn/s, latency: 3744 ms, (p50: 3700 ms, p90: 5200 ms, p99: 6200 ms), latency samples: 302180
2. Upgrading first Validator to new version: 0a8b95c58d036bec1f175aa5b95ca91fc3c8695a
compatibility::simple-validator-upgrade::single-validator-upgrade : committed: 4390 txn/s, latency: 7200 ms, (p50: 8000 ms, p90: 9400 ms, p99: 9700 ms), latency samples: 166820
3. Upgrading rest of first batch to new version: 0a8b95c58d036bec1f175aa5b95ca91fc3c8695a
compatibility::simple-validator-upgrade::half-validator-upgrade : committed: 4845 txn/s, latency: 6533 ms, (p50: 7000 ms, p90: 8000 ms, p99: 8300 ms), latency samples: 174440
4. upgrading second batch to new version: 0a8b95c58d036bec1f175aa5b95ca91fc3c8695a
compatibility::simple-validator-upgrade::rest-validator-upgrade : committed: 6621 txn/s, latency: 4917 ms, (p50: 4800 ms, p90: 7300 ms, p99: 9100 ms), latency samples: 231760
5. check swarm health
Compatibility test for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 0a8b95c58d036bec1f175aa5b95ca91fc3c8695a passed
Test Ok

@github-actions
Copy link
Contributor

✅ Forge suite land_blocking success on 0a8b95c58d036bec1f175aa5b95ca91fc3c8695a

performance benchmark : committed: 5757 txn/s, latency: 6890 ms, (p50: 5700 ms, p90: 10800 ms, p99: 23500 ms), latency samples: 2458260
Max round gap was 1 [limit 4] at version 364860. Max no progress secs was 3.632989 [limit 10] at version 1543888.
Test Ok

@brmataptos brmataptos closed this Jun 13, 2023
auto-merge was automatically disabled June 13, 2023 01:20

Pull request was closed

@brmataptos brmataptos deleted the brianmurphy/docgen branch June 13, 2023 01:20
@github-actions
Copy link
Contributor

✅ Forge suite framework_upgrade success on aptos-node-v1.3.0_3fc3d42b6cfe27460004f9a0326451bcda840a60 ==> 0a8b95c58d036bec1f175aa5b95ca91fc3c8695a

Compatibility test results for aptos-node-v1.3.0_3fc3d42b6cfe27460004f9a0326451bcda840a60 ==> 0a8b95c58d036bec1f175aa5b95ca91fc3c8695a (PR)
Upgrade the nodes to version: 0a8b95c58d036bec1f175aa5b95ca91fc3c8695a
framework_upgrade::framework-upgrade::full-framework-upgrade : committed: 4466 txn/s, latency: 6906 ms, (p50: 7100 ms, p90: 9800 ms, p99: 11400 ms), latency samples: 174200
5. check swarm health
Compatibility test for aptos-node-v1.3.0_3fc3d42b6cfe27460004f9a0326451bcda840a60 ==> 0a8b95c58d036bec1f175aa5b95ca91fc3c8695a passed
Test Ok

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@saharct saharct Awaiting requested review from saharct

@wrwg wrwg Awaiting requested review from wrwg wrwg is a code owner

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
@brmataptos @brianrmurphy