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 new user guide page "Simplifying Code Before Compilation" #6796

Merged
merged 4 commits into from
Jan 22, 2025

Conversation

zliu41
Copy link
Member

@zliu41 zliu41 commented Jan 17, 2025

No description provided.

@zliu41 zliu41 added the No Changelog Required Add this to skip the Changelog Check label Jan 17, 2025
@zliu41 zliu41 requested a review from a team January 17, 2025 03:07
```

Since this is nothing but standard Template Haskell usage, we'll keep it concise here.
There are plenty of Template Haskell resources and examples available elsewhere.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you know of any template haskell resources that would be accessible to beginners (those users whose only exposure to Haskell was learning Plinth)? I often struggle to teach TH to new developers.

Copy link
Member Author

Choose a reason for hiding this comment

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

I guess "plenty of" is not very accurate, but I've come across some good blog posts and tutorials. Also, AI is not terrible at writing and explaining basic TH. i'll update the wording.

Copy link
Contributor

Choose a reason for hiding this comment

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

Btw, I was debugging high memory usage in the plugin recently and it is associated with Plinth code spliced in as a TH quote. It would be nice to make sure that TH is not causing much overhead before advertising its usage.

Copy link
Member Author

Choose a reason for hiding this comment

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

Btw, I was debugging high memory usage in the plugin recently and it is associated with Plinth code spliced in as a TH quote. It would be nice to make sure that TH is not causing much overhead before advertising its usage.

That entirely depends on the code spliced in. TH itself cannot cause overhead - it just generates code programmatically instead of writing by hand. Btw thanks for looking into the memory issue; I'm really curious what it is.

Copy link
Contributor

@colll78 colll78 Jan 20, 2025

Choose a reason for hiding this comment

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

Do you have any TH resources that you think would be semi-beginner friendly that maybe we can link in this documentation? I think it would help a lot. Maybe we can even just link the haskell org TH docs?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sounds good, I added a few links in 4e20ffb.

Copy link
Contributor

@colll78 colll78 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@effectfully effectfully left a comment

Choose a reason for hiding this comment

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

Very well-written.

@zliu41 zliu41 enabled auto-merge (squash) January 21, 2025 23:57
@zliu41 zliu41 merged commit a010dda into master Jan 22, 2025
8 of 10 checks passed
@zliu41 zliu41 deleted the zliu41/simplify-doc branch January 22, 2025 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
No Changelog Required Add this to skip the Changelog Check
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants