[Merged by Bors] - Added documentation to WindowMode to better document what 'use_size' …

[dimitri-br]

This pull request aims to solve the issue of a lack of documentation in the enum WindowMode

Objective

• Fixes Add documentation for bevy_window::window::WindowMode::Fullscreen #3136

Solution

• Added a few lines of documentation that should document what the enum does better

[alice-i-cecile]

Looks great! Thanks for your first PR :)

[Weibye]

👍

[mockersf]

With this change, the field is documented on the enum and on the variant.

I think it would be best to keep the documentation on only one place, and that would be on the field itself. This would be better presented on docs.rs, and will also be the doc that will show up in an IDE. Could you move it there?

Also, "best" is not very explicit on how it is chosen. Could you expand the explanation? It seems "best" is from

bevy/crates/bevy_winit/src/winit_windows.rs

Lines 213 to 227 in 3de391b

	pub fn get_best_videomode(monitor: &winit::monitor::MonitorHandle) -> winit::monitor::VideoMode {
	let mut modes = monitor.video_modes().collect::<Vec<_>>();
	modes.sort_by(|a, b| {
	use std::cmp::Ordering::*;
	match b.size().width.cmp(&a.size().width) {
	Equal => match b.size().height.cmp(&a.size().height) {
	Equal => b.refresh_rate().cmp(&a.refresh_rate()),
	default => default,
	},
	default => default,
	}
	});
	modes.first().unwrap().clone()
	}

so it's picking the one with the bigger height / refresh rate I think?
Or better, add the explanation as doc to this function, then link to it from the field doc.

And from CI, it seems you could run cargo fmt 😃

[mockersf]

This is not true, it will pick the resolution supported by the monitor that is closest to the given resolution, not the given one

[dimitri-br]

I've updated the documentation and ensured the new changes are compatible with bevy. I've tested it on a few examples and it seems to have run pretty well, but a review would be appreciated!

[cart]

bors r+

[cart]

Nice improvements!

[bors]

Pull request successfully merged into main.

Build succeeded:

• build-android
• build (nightly, ubuntu-latest)
• build (stable, macos-latest)
• build (stable, ubuntu-latest)
• build (stable, windows-latest)
• build-wasm (nightly, ubuntu-latest)
• build-wasm (stable, ubuntu-latest)
• check-benches
• check-doc
• check-markdown-links
• check-missing-examples-in-docs
• check-unused-dependencies
• ci
• markdownlint
• run-examples