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

docs: fix principal -construct -destruct api reference #3573

Merged
merged 2 commits into from
Feb 17, 2023
Merged

docs: fix principal -construct -destruct api reference #3573

merged 2 commits into from
Feb 17, 2023

Conversation

hugocaillard
Copy link
Collaborator

@hugocaillard hugocaillard commented Feb 16, 2023

Description

The api reference for principal-construct and principal-destruct was built with the wrong argument


Idea: An other option would be to pass function (and do it for every other make_for_simple_native calls here) to limit the risk of having the same issue in the future

PrincipalDestruct => make_for_simple_native(&PRINCPIPAL_DESTRUCT_API, &function, name),
PrincipalConstruct => make_for_simple_native(&PRINCIPAL_CONSTRUCT_API, &function, name),

I wanted to limit the footprint of my PR but let me know if I should perform this change

Applicable issues

N/A

Additional info (benefits, drawbacks, caveats

Improve the LSP.
The output type is displayed in VSCode (and other editors) on hover

Checklist

N/A

Copy link
Contributor

@pavitthrap pavitthrap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks good! I think the change you proposed sounds good & would be appropriate to include in this pr

@hugocaillard
Copy link
Collaborator Author

Alright I will 👌

Copy link
Contributor

@obycode obycode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

@codecov
Copy link

codecov bot commented Feb 17, 2023

Codecov Report

Merging #3573 (9eabcc5) into develop (5923c48) will decrease coverage by 0.04%.
The diff coverage is 0.00%.

@@             Coverage Diff             @@
##           develop    #3573      +/-   ##
===========================================
- Coverage    29.86%   29.83%   -0.04%     
===========================================
  Files          298      298              
  Lines       275049   275049              
===========================================
- Hits         82152    82061      -91     
- Misses      192897   192988      +91     
Impacted Files Coverage Δ
clarity/src/vm/docs/mod.rs 0.00% <0.00%> (ø)
testnet/stacks-node/src/tests/epoch_205.rs 21.75% <0.00%> (-76.39%) ⬇️
testnet/stacks-node/src/tests/epoch_21.rs 55.32% <0.00%> (-24.16%) ⬇️
clarity/src/vm/functions/tuples.rs 60.00% <0.00%> (-22.86%) ⬇️
clarity/src/vm/ast/traits_resolver/mod.rs 67.14% <0.00%> (-18.58%) ⬇️
...rity/src/vm/analysis/type_checker/v2_1/contexts.rs 67.87% <0.00%> (-16.75%) ⬇️
...ity/src/vm/analysis/type_checker/v2_05/contexts.rs 83.20% <0.00%> (-14.51%) ⬇️
clarity/src/vm/analysis/analysis_db.rs 75.00% <0.00%> (-14.29%) ⬇️
clarity/src/vm/callables.rs 36.19% <0.00%> (-9.62%) ⬇️
clarity/src/vm/functions/define.rs 83.47% <0.00%> (-8.27%) ⬇️
... and 78 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@jcnelson
Copy link
Member

Your doc tests are failing

@jcnelson jcnelson self-requested a review February 17, 2023 02:44
@hugocaillard hugocaillard requested review from obycode and removed request for jcnelson February 17, 2023 14:21
@hugocaillard
Copy link
Collaborator Author

hugocaillard commented Feb 17, 2023

Thanks for warning me @jcnelson, I had to change PRINCIPAL_CONSTRUCT_API to a SpecialAPI

PS: when a re-requested a review from Brice, it removed you as a reviewer and now I don't have the rights to add you again

Copy link
Contributor

@obycode obycode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! Thanks for the updates.

@jcnelson jcnelson merged commit 49c30f3 into stacks-network:develop Feb 17, 2023
@hugocaillard hugocaillard deleted the docs/principal-construct-destruct-api-reference branch February 17, 2023 17:57
@blockstack-devops
Copy link
Contributor

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@stacks-network stacks-network locked as resolved and limited conversation to collaborators Nov 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Status: Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

5 participants