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

Public API needs improvements to make it more extensible #474

Closed
2 tasks
jessebraham opened this issue Sep 14, 2023 · 1 comment · Fixed by #512
Closed
2 tasks

Public API needs improvements to make it more extensible #474

jessebraham opened this issue Sep 14, 2023 · 1 comment · Fixed by #512
Assignees
Labels
bug Something isn't working
Milestone

Comments

@jessebraham
Copy link
Member

jessebraham commented Sep 14, 2023

There are various public functions in the API, such as load_elf_to_flash, which are not extensible in their current form. These functions should be marked as deprecated and be replaced by functions which are extensible. For instance, by taking a #[non_exhaustive] struct containing the required options.

Since we can deprecate the old functions this can be done in a semver-compatible way. We should identify additional functions which need improving and construct a task list below when able.


  • load_elf_to_flash_with_format
  • load_elf_to_flash
@jessebraham jessebraham added the bug Something isn't working label Sep 14, 2023
@SergioGasquez SergioGasquez added this to the v3 milestone Nov 2, 2023
@SergioGasquez
Copy link
Member

Since we are working towards 3.0 we don't need to deprecate functions, we can just remove them to simplify the codebase.

@jessebraham jessebraham changed the title Public API needs improvements to make it more extensible without breaking semver Public API needs improvements to make it more extensible Nov 15, 2023
@SergioGasquez SergioGasquez linked a pull request Nov 17, 2023 that will close this issue
@SergioGasquez SergioGasquez self-assigned this Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants