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

Tighten up public class API #5

Open
apjanke opened this issue Jan 15, 2021 · 0 comments
Open

Tighten up public class API #5

apjanke opened this issue Jan 15, 2021 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@apjanke
Copy link
Owner

apjanke commented Jan 15, 2021

Implement class organization updates in at least two classes towards the goal of a smaller and more inspectable public API for class consumers/library users. This is expected to include changes such as:

  1. Demarcation of the public API from the hidden/private API in the class file, e.g. the public API before the class internals
  2. Initial deprecation steps (e.g. hidden implementation for trivially coded (‘one liner’ or similar) public properties, e.g. nChannels which can be determined by class consumers simply via length(channels_id).
  3. Demarcation of groups of related properties (e.g. derived/computed values) through a property naming strategy (e.g. prefixes) or the creation of a new class linked to existing class via composite pattern
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant