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

feat(docs): new functions from TVM upgrades 2023-07 and 2024-04 #1062

Merged
merged 4 commits into from
Nov 27, 2024

Conversation

novusnota
Copy link
Member

@novusnota novusnota commented Nov 20, 2024

Issue

Closes #909.

Checklist

  • I have updated CHANGELOG.md
  • I have run the linter, formatter and spellchecker
  • I did not do unrelated and/or undiscussed refactorings

@novusnota
Copy link
Member Author

novusnota commented Nov 21, 2024

I'll finish this first thing in the morning, but now I'll go sleep a little

UPD: It took a while, but things look good now.

chore(stdlib): unify doc comments to the latest style

The general idea:
1. What the thing is and which version of Tact it became available in
2. Further description of what it does, if necessary
3. Usage examples, wrapped in a function body for highlighting and
immediate copy-paste when editing
4. "See" links to the related pages in Tact and TON docs or elsewhere

And the most important part — all descriptions come directly from docs
and then get stripped of doc-specific things, like inlined links `[]()`
(or `[][]`)  or `{:tact}` directives for highlighting.

chore(CI): bump action versions to prevent Node.js 16 deprecation issues

See:
https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default
@novusnota novusnota marked this pull request as ready for review November 21, 2024 15:39
@novusnota novusnota requested a review from a team as a code owner November 21, 2024 15:39
@novusnota novusnota changed the title WIP feat(docs): new functions from TVM 2023-07 and 2024-04 feat(docs): new functions from TVM 2023-07 and 2024-04 Nov 21, 2024
@novusnota novusnota changed the title feat(docs): new functions from TVM 2023-07 and 2024-04 feat(docs): new functions from TVM upgrades 2023-07 and 2024-04 Nov 21, 2024
Copy link
Member

@anton-trunov anton-trunov left a comment

Choose a reason for hiding this comment

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

@novusnota
Copy link
Member Author

If there are no more suggestions, let's merge this now and add real-world examples of fee calculation in #1068 in the future (as I suggested here).

Wdyt, folks @anton-trunov @Gusarich @Shvandre?

@anton-trunov
Copy link
Member

If there are no more suggestions, let's merge this now and add real-world examples of fee calculation in #1068 in the future (as I #1062 (comment)).

sure

@anton-trunov anton-trunov added this to the v1.6.0 milestone Nov 27, 2024
@anton-trunov anton-trunov self-assigned this Nov 27, 2024
@novusnota novusnota merged commit 8237edb into main Nov 27, 2024
18 checks passed
@novusnota novusnota deleted the closes-909 branch November 27, 2024 18:51
sansx pushed a commit to TownSquareXYZ/tact that referenced this pull request Dec 9, 2024
…-lang#1062)

* feat(docs): new TVM functions from 2023-07 and 2024-04 upgrades

* chore(stdlib): unify doc comments to the latest style

The general idea:
1. What the thing is and which version of Tact it became available in
2. Further description of what it does, if necessary
3. Usage examples, wrapped in a function body for highlighting and
immediate copy-paste when editing
4. "See" links to the related pages in Tact and TON docs or elsewhere

And the most important part — all descriptions come directly from docs
and then get stripped of doc-specific things, like inlined links `[]()`
(or `[][]`)  or `{:tact}` directives for highlighting.

* chore(CI): bump action versions to prevent Node.js 16 deprecation issues

See:
https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default
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.

Document stdlib functions for the new TVM instructions from 2023.07 and 2024.04 upgrades
3 participants