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

doc: fix a typo in the rtcinterrupt example #3981

Merged
merged 2 commits into from
Nov 2, 2023

Conversation

graugans
Copy link
Contributor

I came across this while glancing through the examples.

Maybe it also makes sense to link to the docs like this: https://tinygo.org/docs/concepts/compiler-internals/heap-allocation/
Is it worth adding the hint about blocking and memory to the interrupt documentation page https://tinygo.org/docs/concepts/compiler-internals/interrupts/ as well? This came to my mind when I was thinking if fmt.Println() is blocking or not I am pretty sure it does :-)

@deadprogram
Copy link
Member

@graugans those seem like very good suggestions. Can you please add that?

@graugans
Copy link
Contributor Author

@graugans those seem like very good suggestions. Can you please add that?

I'll do my best.

The examples shall be short and not overloaded with too much
information. The details can be read up in the documentation.

Signed-off-by: Christian Ege <[email protected]>
@graugans
Copy link
Contributor Author

graugans commented Nov 1, 2023

I have added a link to the online documentation. I will create a Pull-Request for the documentation project to provide more hints about interrupts. See tinygo-org/tinygo-site#378

@deadprogram
Copy link
Member

Thanks @graugans for the doc improvement. Now squash/merging.

@deadprogram deadprogram merged commit 5355473 into tinygo-org:dev Nov 2, 2023
15 checks passed
crypto-smoke pushed a commit to meshnet-gophers/tinygo that referenced this pull request Feb 14, 2024
docs: fix a typo in the rtcinterrupt example, also provide a link to the interrupt online doc
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