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

Remove feature descriptions in FEATURES.md #3479

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

madsmtm
Copy link
Member

@madsmtm madsmtm commented Feb 9, 2024

Builds upon #3478. Related to #3431.

I went through all of the text in FEATURES.md, and cross-referenced it with our code, and as I suspected, the information in the code is much more detailed and up to date. So I propose we remove most of the contents in FEATURES.md, as it is difficult to keep up to date, and I don't really see the value provided.

Only thing I'm unsure about is the following three points that are yet unimplemented, and as such doesn't have a clear reference in our code:

  • Popup / modal windows: Windows can be created relative to the client area of other windows, and parent windows can be disabled in favor of popup windows. This feature also guarantees that popup windows get drawn above their owner.
  • Gamepad/Joystick events: Capturing input from gamepads and joysticks.
  • Device movement events: Capturing input from the device gyroscope and accelerometer.

@madsmtm madsmtm added S - docs Awareness, docs, examples, etc. S - maintenance Repaying technical debt labels Feb 9, 2024
@madsmtm madsmtm force-pushed the a-bit-of-documentation-on-docsrs branch from 88ed94e to 75854b5 Compare February 23, 2024 14:27
Base automatically changed from a-bit-of-documentation-on-docsrs to master February 23, 2024 14:35
Copy link
Member

@daxpedda daxpedda 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 this is the right way to go.
Will take a closer look when its ready.

@kchibisov
Copy link
Member

bump

Copy link
Member

@daxpedda daxpedda left a comment

Choose a reason for hiding this comment

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

LGTM.

My small nit can be addressed in a follow-up.

Copy link
Member

Choose a reason for hiding this comment

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

I feel like this file is now quite small and its contents should either live in README.md, CONTRIBUTING.md or be removed entirely.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S - docs Awareness, docs, examples, etc. S - maintenance Repaying technical debt
Development

Successfully merging this pull request may close these issues.

None yet

3 participants