Skip to content

Document feature flags#465

Merged
Ogeon merged 1 commit intoOgeon:masterfrom
joshka:codex/document-feature-flags
Mar 30, 2026
Merged

Document feature flags#465
Ogeon merged 1 commit intoOgeon:masterfrom
joshka:codex/document-feature-flags

Conversation

@joshka
Copy link
Copy Markdown
Contributor

@joshka joshka commented Mar 28, 2026

Summary

  • move the feature documentation into the crate-level getting started section
  • match the feature wording and grouping with palette/README.md
  • keep the original feature definitions unchanged in Cargo.toml

Why

This follows the same documentation pattern used by palette_math, where the crate docs and README
can be edited in tandem without introducing another source of truth for feature descriptions.

Closes #415.

Validation

  • cargo +nightly docs-rs -p palette

@joshka joshka changed the title [codex] Document feature flags Document feature flags Mar 28, 2026
@joshka
Copy link
Copy Markdown
Contributor Author

joshka commented Mar 28, 2026

image

@joshka joshka marked this pull request as ready for review March 28, 2026 20:44
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented Mar 29, 2026

Merging this PR will not alter performance

✅ 47 untouched benchmarks


Comparing joshka:codex/document-feature-flags (caa8a92) with master (60db153)

Open in CodSpeed

@Ogeon
Copy link
Copy Markdown
Owner

Ogeon commented Mar 29, 2026

Hi, thanks for taking the time to do this! I should have done something similar long ago but it slipped my mind.

As much as I appreciate the help and effort, I would like the wording and grouping to match the readme and for it to be part of a "getting started" section up top. If you look at what I did for palette_math, you can see that it's essentially a copy of that part of the readme. That makes it easy to edit them in tandem. In fact, I don't mind going without document-features since it doesn't completely remove the duplication. Copy-pasting is simple too. 😅

Second, please don't change the feature set, even though some may seem useless. It's a breaking change after all and potentially unnecessary churn.

Also please follow the template for closed issues. Those keywords will close the issue automatically, and I'm also using a script for reading them when generating the release notes.

Oh and ignore the miri error, it's just fallout from floating point number randomization they added to emulate platform differences. I just got to relax the precision requirement in that test.

@Ogeon
Copy link
Copy Markdown
Owner

Ogeon commented Mar 29, 2026

The miri error should hopefully be fixed now if you rebase this on top of master.

@joshka joshka force-pushed the codex/document-feature-flags branch from 9a062d4 to 084eb35 Compare March 29, 2026 16:59
Move the feature documentation into the crate-level getting
started section, match the README wording and grouping, and
clarify the `libm` requirement for `no_std` builds.
@joshka joshka force-pushed the codex/document-feature-flags branch from 084eb35 to caa8a92 Compare March 29, 2026 17:02
@Ogeon
Copy link
Copy Markdown
Owner

Ogeon commented Mar 29, 2026

Ah, great! Thank you!

@Ogeon Ogeon merged commit 6c1a85b into Ogeon:master Mar 30, 2026
20 checks passed
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.

Clarify that libm is needed for no_std

2 participants