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

Cleanup and document engine-sample.input #580

Merged
merged 1 commit into from
Sep 28, 2023

Conversation

DiogoMendonc-a
Copy link
Contributor

No description provided.

@DiogoMendonc-a DiogoMendonc-a linked an issue Sep 25, 2023 that may be closed by this pull request
@github-actions
Copy link
Contributor

github-actions bot commented Sep 25, 2023

PR Preview Action v1.4.4
🚀 Deployed preview to https://GameDevTecnico.github.io/cubos/pr-preview/pr-580/
on branch gh-pages at 2023-09-27 12:43 UTC

@codecov
Copy link

codecov bot commented Sep 25, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (798de30) 29.71% compared to head (6273cf5) 29.71%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #580   +/-   ##
=======================================
  Coverage   29.71%   29.71%           
=======================================
  Files          86       86           
  Lines        6158     6158           
=======================================
  Hits         1830     1830           
  Misses       4328     4328           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@luishfonseca luishfonseca left a comment

Choose a reason for hiding this comment

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

This sample is overcomplicated (my bad), some suggestions to simplify it:

engine/samples/input/page.md Outdated Show resolved Hide resolved
engine/samples/input/page.md Show resolved Hide resolved
@RiscadoA RiscadoA changed the title docs(engine): document Input sample Clean up and document engine-sample.input Sep 25, 2023
@RiscadoA RiscadoA changed the title Clean up and document engine-sample.input Cleanup and document engine-sample.input Sep 25, 2023
@DiogoMendonc-a DiogoMendonc-a force-pushed the 472-cleanup-and-document-engine-sampleinput branch from 5a414b9 to c97b77e Compare September 27, 2023 08:22
Copy link
Member

@RiscadoA RiscadoA left a comment

Choose a reason for hiding this comment

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

I think you should mention in the docs thar Input is a resource and that the showcase functions you're showing are not systems, and that there's a system passing the input resource there.
Maybe you should show that system or part of it too, just to make it clear where stuff is coming from.

@DiogoMendonc-a DiogoMendonc-a force-pushed the 472-cleanup-and-document-engine-sampleinput branch from 01cd6e1 to 6273cf5 Compare September 27, 2023 12:41
@DiogoMendonc-a DiogoMendonc-a merged commit d560480 into main Sep 28, 2023
8 checks passed
@DiogoMendonc-a DiogoMendonc-a deleted the 472-cleanup-and-document-engine-sampleinput branch September 28, 2023 08:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cleanup and document engine-sample.input
3 participants