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

Improve consistency and clarity of string conversion table in the Overview #231

Open
ghost opened this issue Aug 16, 2024 · 0 comments
Open

Comments

@ghost
Copy link

ghost commented Aug 16, 2024

issue
The use of the conceptual term st in the string type conversion table https://odin-lang.org/docs/overview/#string-type-conversions may not be consistent.

examples
st is used here https://odin-lang.org/docs/overview/#from-rune-to-string as the input to: utf8.runes_to_string(st)
st is not used here https://odin-lang.org/docs/overview/#from-u8-and-length-int-to-string as the input to: strings.string_from_ptr(ptr, length)

suggestions for improvement in increasing level of effort for the change

  1. update the second one above to be consistent with the rest of all the tables and use st as the "input string"
  2. (more work) have a a different legend for each "from X to Y"
  3. actually use the types from the source code that the procedure accepts - I think this is the superior choice for clarity and consistency, but is more work. It would not require a flexible term like st that means different things for each conversion procedure listed.
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

No branches or pull requests

0 participants