Skip to content

Conversation

@timholy
Copy link
Member

@timholy timholy commented Jul 7, 2024

This aims to rewrite the documentation loosely in the style advocated by divio.
It acknowledges the existence of PrecompileTools and focuses on how you use SnoopCompile to understand why precompilation isn't working the way you'd like.

@timholy timholy mentioned this pull request Jul 7, 2024
6 tasks
@timholy timholy marked this pull request as ready for review July 23, 2024 12:28
Copy link
Member Author

@timholy timholy left a comment

Choose a reason for hiding this comment

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

At long last (looong last), this is almost ready. I need to work through one of the demos ("Using @snoop_inference to improve inferability") and likely fix some issues at the end, but otherwise I think this is ready for anyone who wants to review it.

@timholy
Copy link
Member Author

timholy commented Jul 23, 2024

You can click on the documenter/deploy link above or see https://timholy.github.io/SnoopCompile.jl/previews/PR389/

@timholy
Copy link
Member Author

timholy commented Jul 23, 2024

Hmm, Documenter seems like it might have trouble until we register this 😢 . Specifically, the lines in the documentation that encourage you to Pkg.add(["SnoopCompile", ...]) are problematic for an unregistered version. But I think those lines serve a purpose.

@timholy
Copy link
Member Author

timholy commented Jul 23, 2024

OK, should be working now. Thanks to @asinghvi17!

timholy added 17 commits July 24, 2024 02:44
Switches from darts to blackjack. There were several features about the
darts example that made for poor teaching, including the gap between
`@enum` and a `struct` and the artificiality of not extending the base
package.

Also polishes the explanations and improves how things are named.
This is intended to encourage users to collect data with just SnoopCompileCore.
@timholy
Copy link
Member Author

timholy commented Jul 24, 2024

OK, I think this is finally ready. I anticipate merging and releasing SnoopCompile 3.0.0 later today.

@timholy timholy merged commit 96c83db into master Jul 24, 2024
@timholy timholy deleted the teh/doc_rewrite branch July 24, 2024 15:57
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