Skip to content

API: document which Preferences are experimental or enabled by default#44171

Merged
jdm merged 3 commits into
servo:mainfrom
sabbCodes:issue-43706
Apr 15, 2026
Merged

API: document which Preferences are experimental or enabled by default#44171
jdm merged 3 commits into
servo:mainfrom
sabbCodes:issue-43706

Conversation

@sabbCodes

Copy link
Copy Markdown
Contributor

Referred users to https://book.servo.org/design-documentation/experimental-features.html documentation for Preferences and EXPERIMENTAL_PREFS

Testing: No testing required, build was successful.
Fixes: #43706

@servo-highfive servo-highfive added the S-awaiting-review There is new code that needs to be reviewed. label Apr 13, 2026
Comment thread components/config/prefs.rs Outdated
Comment on lines +89 to +90
/// - **Experimental**: disabled by default, but enabled in servoshell's experimental mode
/// via the `--experimental` flag.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What is the --experimental flag? This doesn't seem like a real thing or has it been added?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Additionally, I'm not sure if it makes sense to talk about servoshell's command-line arguments in the API documentation. The idea is that servoshell is a test application and this documentation is meant for people writing their own applications.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

What is the --experimental flag? This doesn't seem like a real thing or has it been added?

I meant the --enable-experimental-web-platform-features in this page

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Additionally, I'm not sure if it makes sense to talk about servoshell's command-line arguments in the API documentation. The idea is that servoshell is a test application and this documentation is meant for people writing their own applications.

Okay, thanks for pointing it out.

Signed-off-by: Sabb <sarafaabbas@gmail.com>
@sabbCodes

Copy link
Copy Markdown
Contributor Author

Hi @jdm would you mind reviewing this?

Comment thread ports/servoshell/prefs.rs Outdated
@servo-highfive servo-highfive removed the S-awaiting-review There is new code that needs to be reviewed. label Apr 14, 2026
Co-authored-by: Josh Matthews <josh@joshmatthews.net>
Signed-off-by: Abbas Olanrewaju Sarafa <109840351+sabbCodes@users.noreply.github.com>
@servo-highfive servo-highfive added the S-awaiting-review There is new code that needs to be reviewed. label Apr 15, 2026
@jdm jdm enabled auto-merge April 15, 2026 04:17
@sabbCodes

Copy link
Copy Markdown
Contributor Author

All done now, @jdm

@jdm jdm added this pull request to the merge queue Apr 15, 2026
@servo-highfive servo-highfive added the S-awaiting-merge The PR is in the process of compiling and running tests on the automated CI. label Apr 15, 2026
Merged via the queue into servo:main with commit 316e621 Apr 15, 2026
33 checks passed
@servo-highfive servo-highfive removed the S-awaiting-merge The PR is in the process of compiling and running tests on the automated CI. label Apr 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-awaiting-review There is new code that needs to be reviewed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

api: Document which Preferences are experimental or enabled by default

4 participants