Improve documentation #1765
Merged
Improve documentation #1765
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #1765 +/- ##
==========================================
- Coverage 77.43% 77.43% -0.01%
==========================================
Files 306 305 -1
Lines 62442 62552 +110
==========================================
+ Hits 48355 48437 +82
- Misses 12467 12494 +27
- Partials 1620 1621 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
Cadence Benchstat comparisonThis branch with compared with the base branch onflow:master commit 3db7348 Collapsed results for better readability
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dsainati1
reviewed
Jun 27, 2022
docs/language/accounts.mdx
Outdated
| @@ -198,7 +198,8 @@ struct AccountKey { | |||
| let isRevoked: Bool | |||
| } | |||
| ``` | |||
| Refer the [PublicKey](crypto/#publickey) section for more details on the creation and validity of public keys. | |||
|
|
|||
| Refer the [`PublicKey` section](crypto/#publickey) for more details on the creation and validity of public keys. | |||
There was a problem hiding this comment.
Suggested change
| Refer the [`PublicKey` section](crypto/#publickey) for more details on the creation and validity of public keys. | |
| Refer to the [`PublicKey` section](crypto/#publickey) for more details on the creation and validity of public keys. |
| ``` | ||
|
|
||
| It is invalid to declare a synthetic field with only a setter. | ||
| Initializers do not support overloading. |
There was a problem hiding this comment.
Do we want to add some language here to call out that we plan on supporting this in the future? While documenting the behavior as if it exists is misleading, a statement like this may give the impression that we have no intention of ever supporting overloading at all. Perhaps something like "Initializers do not currently support overloading, but there are plans to add support for this in the future."
There was a problem hiding this comment.
Agreed. There aren't any plans to add support for overloading at the moment, it's just a feature I had thought we would want when writing this 3 years ago, and since then there has been no mention/discussion around it
| } | ||
| } | ||
| ``` | ||
| Functions do not support overloading. |
There was a problem hiding this comment.
Same comments here as about initializers.
turbolent
commented
Jun 27, 2022
turbolent
commented
Jun 27, 2022
Co-authored-by: Daniel Sainati <[email protected]>
6 tasks
Co-authored-by: Joshua Hannan <[email protected]>
turbolent
added a commit
that referenced
this pull request
Oct 4, 2022
accidentally deleted in #1765
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1701
Closes #1328
Closes #1282
Closes #1237
Closes #1223
Closes #1203
Work towards #959
masterbranchFiles changedin the Github PR explorer