Skip to content

doc: add an example for make-parameter - #5052

Open
sorawee wants to merge 1 commit into
racket:masterfrom
sorawee:doc-param
Open

sorawee wants to merge 1 commit into
racket:masterfrom
sorawee:doc-param

Conversation

@sorawee

@sorawee sorawee commented Aug 5, 2024

Copy link
Copy Markdown
Collaborator

@mflatt

mflatt commented Aug 5, 2024

Copy link
Copy Markdown
Member

This looks helpful, thanks! I think I'd be inclined to use parameterize for most examples, instead of emphasizing imperative use of parameters, but you may have already considered the trade-offs there.

@sorawee

sorawee commented Aug 6, 2024

Copy link
Copy Markdown
Collaborator Author

Yeah, I intentionally didn't use parameterize here because there are already a lot of clear examples of parameterize under parameterize.

We could demonstrate how parameterize works here as well, but then I think it would be weird to have examples in both make-parameter and parameterize being similar.

However, I understand your concern that people might see the example, and thought that the imperative use is the way to use parameters. Maybe we can improve the prose above at the beginning of the section to make clear that parameterize is preferred?

@rfindler

rfindler commented Aug 6, 2024 via email

Copy link
Copy Markdown
Member

@shhyou shhyou added the documentation Issues related to README and documentation (typos, rewording, new docs, etc) label Aug 9, 2024
@shhyou shhyou added good first issue pr:needs-work A PR that's wanted but needs work to be mergeable. labels Sep 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Issues related to README and documentation (typos, rewording, new docs, etc) good first issue pr:needs-work A PR that's wanted but needs work to be mergeable.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants