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

Add mutability changes to Cadence documentation #172

Merged
merged 6 commits into from
Aug 2, 2023

Conversation

SupunS
Copy link
Member

@SupunS SupunS commented Jul 27, 2023

Closes onflow/cadence#2684

Update documentation with the changes introduced in mutability FLIPs: onflow/flips#89, onflow/flips#86, and onflow/flips#94

@vercel
Copy link

vercel bot commented Jul 27, 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 Aug 2, 2023 4:27pm

@SupunS SupunS self-assigned this Jul 27, 2023
@SupunS SupunS marked this pull request as ready for review July 27, 2023 21:00
docs/cadence/language/access-control.md Show resolved Hide resolved
docs/cadence/language/access-control.md Outdated Show resolved Hide resolved
docs/cadence/language/references.mdx Outdated Show resolved Hide resolved
docs/cadence/language/references.mdx Outdated Show resolved Hide resolved
docs/cadence/language/references.mdx Outdated Show resolved Hide resolved
docs/cadence/language/references.mdx Outdated Show resolved Hide resolved
docs/cadence/language/references.mdx Outdated Show resolved Hide resolved
docs/cadence/language/references.mdx Outdated Show resolved Hide resolved
access(Map) fun getRef(): auth(Map) &SubResource {
return &self.childResource as auth(Map) &SubResource
}
access(Map) let childResource: @SubResource
Copy link
Contributor

Choose a reason for hiding this comment

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

Has documentation already been added/changed for entitlement mappings explaining how they work with resource-typed fields?

Copy link
Member Author

@SupunS SupunS Aug 1, 2023

Choose a reason for hiding this comment

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

I did not specifically add about resource typed fields, since this section already describes how entitlement mappings pass down the entitlements in general. Also, the newly added Field and Index Access (in reference.md) section describes how references and entitlements are received when accessing fields through a reference.

If we want to have a more granular/in-depth explanation on how entitlement mappings behave on each different use case (functions, references, and container-typed field) separately, then I guess that also makes sense and would be good to have it too. But probably unrelated to this change, so maybe we could do it in a separate PR?

Copy link
Member

@turbolent turbolent left a comment

Choose a reason for hiding this comment

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

Nice!

docs/cadence/language/references.mdx Show resolved Hide resolved
@turbolent
Copy link
Member

Maybe wait for @dsainati1's final approval before merging

@SupunS SupunS merged commit 70fb354 into main Aug 2, 2023
2 checks passed
@SupunS SupunS deleted the supun/mutability-changes branch August 2, 2023 17:22
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.

Update documentation for mutability changes
3 participants