rename 'w and 's to 'world and 'state

[LamequeFernandes]

Co-Authored-by: Peh099 pedrohenriquec099@gmail.com

Objective

Rename 'w and 's to 'world and 'state in SystemParam. As described in the first topic of issue #6953.

Solution

Rename arguments in documentation.

---

Changelog

Renamed 'w and 's to 'world and 'state in documentation about SystemParam .

[LamequeFernandes]

We wondered if it was also necessary to rename the 'w and 's of the functions that were outside the comments in the documentation.

[MrGVSV]

I could be wrong, but isn't 'w and 's required when using the SystemParam derive? If so, this change might be confusing. Maybe you could just give a call out to the the fact that they're for 'world and 'state (e.g. "...the 'w lifetime (otherwise known as the world lifetime)...")

---

Edit: Yeah looks like it. Here are the results from check-doc:

error: invalid lifetime name: expected `'w` or `'s`
        'w -- refers to data stored in the World.
        's -- refers to data stored in the SystemParam's state.'
 --> src/system/system_param.rs:1528:21
  |
7 | struct GenericParam<'world,'state, T: SystemParam + 'static> {
  |                     ^^^^^^

[nicopap]

See also #6953

[inodentry]

Bikeshed: should it be 'system instead of 'state?

[alice-i-cecile]

Bikeshed: should it be 'system instead of 'state?

No, this isn't only useful in systems.

[alice-i-cecile]

@LamequeFernandes it looks like you need to update the SystemParam macro for this to pass CI.

[alice-i-cecile]

Nice: can you resolve conflicts? Either merge main into this branch or rebase this PR.

[LamequeFernandes]

Nice: can you resolve conflicts? Either merge main into this branch or rebase this PR.

Yes, I can, I'll do it with @Peh099 right now :)

[alice-i-cecile]

Rebase looks good, but looks like there's a couple places to touch up still :)

[CGMossa]

Was it done elsewhere?

[alice-i-cecile]

No; this still needs to be redone.