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

Remove pub, priv and pub(set) documentation #146

Merged
merged 5 commits into from
Jul 18, 2023

Conversation

dsainati1
Copy link
Contributor

With onflow/cadence#2540 merged, these access modifiers are going away in Stable Cadence.

Note that docs/concepts/staking/05-epoch-scripts-events.md and docs/tooling/unity-sdk/samples/nft-browser.md still contain pub(set) access modifiers, but given that these reflect real contracts, I did not want to update them unilaterally. Once these contracts are updated, the docs should change to match them.

@vercel
Copy link

vercel bot commented Jun 23, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 14, 2023 5:11pm

Copy link
Member

@joshuahannan joshuahannan left a comment

Choose a reason for hiding this comment

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

Some of the updated docs reflect contracts that are currently deployed and would not reflect the versions shown in this PR, like FlowToken, FlowIDTableStaking, NFTStorefront, StakingCollection, FlowEpoch, and the token standards.

In your description, you said you don't want to update the docs for deployed contracts until the contracts have been updated, so we should revert all of those until the contracts have been updated, right?

Copy link
Member

Choose a reason for hiding this comment

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

All the tutorials have separate saved playground projects which will also need to be updated to reflect these changes

Copy link
Member

Choose a reason for hiding this comment

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

I'll create an issue for it and add it to our backlog. Not sure exactly when we'll get to it, but it should hopefully be soon

Copy link
Member

Choose a reason for hiding this comment

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

@dsainati1
Copy link
Contributor Author

cc @SupunS @joshuahannan can you take another look at this?

@dsainati1 dsainati1 merged commit eabe317 into main Jul 18, 2023
2 checks passed
@dsainati1 dsainati1 deleted the sainati/remove-pub-priv-docs branch July 18, 2023 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants