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 tutorials #15

Merged
merged 9 commits into from
Nov 17, 2023
Merged

Add tutorials #15

merged 9 commits into from
Nov 17, 2023

Conversation

baggepinnen
Copy link
Contributor

@baggepinnen baggepinnen commented Oct 18, 2023

This PR adds tutorials corresponding roughly to the topics discussed in #1


Depended on

@topolarity topolarity added this to the Public MVP milestone Oct 23, 2023
@baggepinnen baggepinnen changed the title WIP: Add tutorials Add tutorials Oct 26, 2023
@baggepinnen baggepinnen marked this pull request as ready for review October 26, 2023 07:17
@baggepinnen baggepinnen force-pushed the fb/tutorials branch 3 times, most recently from 5a527f5 to 18398e3 Compare November 10, 2023 08:15
@baggepinnen
Copy link
Contributor Author

I can't quite figure out why a test I added to one of the documentation examples is failing on CI:

┌ Error: failed to run `@example` block in src/tutorials/error_recovery.md:54-58
│ ```@example ERROR
│ treading_lightly() # Warm start
│ allocated_memory = @allocated treading_lightly() # A call that triggers the exception path
│ @test allocated_memory < 1e4
│ ```
│   exception = There was an error during testing

When I run the code locally, I get

julia> allocated_memory
288

@topolarity
Copy link
Member

I can't quite figure out why a test I added to one of the documentation examples is failing on CI:

Also fails for me locally if I run julia ./docs/make.jl

Not sure what the root problem is, so for now I've commented out the @test. Documenter has its own Eval loop that it uses to evaluate code, which might be contributing to this.

Copy link
Member

@topolarity topolarity left a comment

Choose a reason for hiding this comment

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

Superb work @baggepinnen

I'm very happy to be merging this 👍

@topolarity topolarity merged commit 19fd030 into main Nov 17, 2023
4 checks passed
@baggepinnen baggepinnen deleted the fb/tutorials branch November 17, 2023 17:50
@topolarity topolarity mentioned this pull request Nov 17, 2023
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.

Add documentation to clarify that calling an allocation-free function can still allocate
2 participants