Skip to content

Terminology. Plz bikeshed.#1

Merged
ikskuh merged 2 commits intomainfrom
glossary_bringup
Jul 11, 2024
Merged

Terminology. Plz bikeshed.#1
ikskuh merged 2 commits intomainfrom
glossary_bringup

Conversation

@ikskuh
Copy link
Copy Markdown
Contributor

@ikskuh ikskuh commented Jul 17, 2023

Bringup of a terminology index. I want to use a uniform language so we have uniform APIs in MicroZig

cc @vesim987 @mattnite

@PhilippWendel
Copy link
Copy Markdown

The table looks fine so far.
Some other terms to add/discuss are Controller/Device or Controller/Target for spi and i2c with Master/Slave as don't use and init/setup/open/create.

@PhilippWendel
Copy link
Copy Markdown

The table looks fine so far. Some other terms to add/discuss are Controller/Device or Controller/Target for spi and i2c with Master/Slave as don't use and init/setup/open/create.

Init/Setup terminology should be different for things that can also be deinited (e.g. stuff that could run in a bootloader)

@ikskuh
Copy link
Copy Markdown
Contributor Author

ikskuh commented Jul 30, 2023

Init/Setup terminology should be different for things that can also be deinited (e.g. stuff that could run in a bootloader)

How do you mean that?

I pushed some changes i did a while ago and totally forgot to push

@PhilippWendel
Copy link
Copy Markdown

How do you mean that?

If a struct can initialized and deinitialized, those members should use a different naming scheme than the member of a struct that only needs to be initialized.
This would let users clearly know when they can deinit something or not, without depending on an lsp and code completion.
Under normal circumstances there is no need to deinit something, bootloaders would be an example where users might want to deinit something.

@ikskuh
Copy link
Copy Markdown
Contributor Author

ikskuh commented Jul 30, 2023

Ah, this is a good question 🤔

Maybe we can use setup() or something

@ikskuh ikskuh merged commit 807a9b8 into main Jul 11, 2024
@ikskuh
Copy link
Copy Markdown
Contributor Author

ikskuh commented Jul 11, 2024

Merged that because we need it for the HAL discussion and we didn't had any expected bikeshedding

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants