Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve generic parameter names #213

Merged
merged 15 commits into from
Apr 18, 2023
Merged

Improve generic parameter names #213

merged 15 commits into from
Apr 18, 2023

Conversation

Anders429
Copy link
Owner

Replaces cryptic letters (C, R, S, etc.) with full names for public-facing generic parameters. Closes #171.

The only one I didn't touch was System::run() and ParSystem::run(). I would like for those to look as unintimidating as possible to external users, and the effort to make it so is being tracked in #188.

@Anders429 Anders429 added C - Documentation Category: Improvements or additions to documentation. C - Code Quality Category: Addressing quality and cleanup of existing code. P - Low Priority: Not particularly urgent. C - Usability Category: How easy it is for users to use the library. labels Apr 18, 2023
@codecov
Copy link

codecov bot commented Apr 18, 2023

Codecov Report

Merging #213 (0e4bf12) into dev (5c8411f) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##              dev     #213   +/-   ##
=======================================
  Coverage   96.94%   96.94%           
=======================================
  Files          85       85           
  Lines       14000    14017   +17     
=======================================
+ Hits        13572    13589   +17     
  Misses        428      428           
Impacted Files Coverage Δ
src/entity/mod.rs 100.00% <ø> (ø)
src/system/schedule/mod.rs 100.00% <ø> (ø)
src/world/impl_clone.rs 100.00% <ø> (ø)
src/world/impl_debug.rs 0.00% <ø> (ø)
src/world/impl_default.rs 100.00% <ø> (ø)
src/world/impl_eq.rs 100.00% <ø> (ø)
src/entities/mod.rs 100.00% <100.00%> (ø)
src/world/entry.rs 96.08% <100.00%> (+0.06%) ⬆️
src/world/impl_serde.rs 99.25% <100.00%> (ø)
src/world/mod.rs 99.90% <100.00%> (+<0.01%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@Anders429 Anders429 merged commit 6589f5d into dev Apr 18, 2023
@Anders429 Anders429 deleted the name branch April 18, 2023 00:44
@Anders429 Anders429 added this to the 0.9.0 milestone Apr 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C - Code Quality Category: Addressing quality and cleanup of existing code. C - Documentation Category: Improvements or additions to documentation. C - Usability Category: How easy it is for users to use the library. P - Low Priority: Not particularly urgent.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant