# Improvements to docs and text · gitcafe/zig

[View on GitCafe](https://git.cafe/gitcafe/zig/commit/bc8e1e1de4a2f22c56528240d320f682f1ec4b69)

Repository: [gitcafe/zig](https://git.cafe/gitcafe/zig)

Visibility: public

Requested revision: bc8e1e1de4a2f22c56528240d320f682f1ec4b69

Requested commit: bc8e1e1de4a2f22c56528240d320f682f1ec4b69

Commit: bc8e1e1de4a2f22c56528240d320f682f1ec4b69

Tree: ad2bd1a996d5cb74570e22bda1adc00c59867c08

Author: zooster

Committer: GitHub

## Message

```
Improvements to docs and text

* docs(std.math): elaborate on difference between absCast and absInt

* docs(std.rand.Random.weightedIndex): elaborate on likelihood

I think this makes it easier to understand.

* langref: add small reminder

* docs(std.fs.path.extension): brevity

* docs(std.bit_set.StaticBitSet): mention the specific types

* std.debug.TTY: explain what purpose this struct serves

This should also make it clearer that this struct is not supposed to provide unrelated terminal manipulation functionality such as setting the cursor position or something because terminals are complicated and we should keep this struct simple and focused on debugging.

* langref(package listing): brevity

* langref: explain what exactly `threadlocal` causes to happen

* std.array_list: link between swapRemove and orderedRemove

Maybe this can serve as a TLDR and make it easier to decide.

* PrefetchOptions.locality: clarify docs that this is a range

This confused me previously and I thought I can only use either 0 or 3.

* fix typos and more

* std.builtin.CallingConvention: document some CCs

* langref: explain possibly cryptic names

I think it helps knowing what exactly these acronyms (@clz and @ctz) and
abbreviations (@popCount) mean.

* variadic function error: add missing preposition

* std.fmt.format docs: nicely hyphenate

* help menu: say what to optimize for

I think this is slightly more specific than just calling it
"optimizations". These are speed optimizations. I used the word
"performance" here.
```

## Parents

- [658b4db223c24616a95cdf3bb3226caa23a3b50e](https://git.cafe/gitcafe/zig/commit/658b4db223c24616a95cdf3bb3226caa23a3b50e?format=markdown)

[Source at this commit](https://git.cafe/gitcafe/zig/tree/bc8e1e1de4a2f22c56528240d320f682f1ec4b69?format=markdown)