Archipelago/docs
Doug Hoskisson 5e06a75bf2
Core: typing: return type of `fill_slot_data` to `Mapping` (#2876)
* Core: typing: return type of `fill_slot_data` to `Mapping`

type checker be like:

"Wait a minute! If you give this mutable dict to those sussy sketchbags, they might mutate it and invalidate your more specific typing!"

Note that this doesn't mean the return value needs to be immutable. It just means the caller won't mutate it (which matches current `Main.py` implementation).

I've seen some talk of introducing ownership to the type system.

https://discuss.python.org/t/we-may-need-better-specification-for-existing-and-future-refinement-types-in-the-type-system/43955/5

Then maybe I could say: "Do whatever you want with it, because I'm giving up ownership."
But that doesn't exist in the type system currently.

* in docs too

* docs talk less about type and more about json

* keep `dict` to be safe with .net client and json
2024-02-29 02:22:42 +01:00
..
img Docs: slight adding games.md rework (#1192) 2023-10-27 12:30:32 +02:00
network diagram Docs: Revise all docs mentioning Lua in EmuHawk (which are in English), and other misc. corrections (#1782) 2023-06-26 08:53:44 +02:00
CODEOWNERS TUNIC: Implement New Game (#2172) 2024-01-12 20:32:15 +01:00
adding games.md Docs: slight adding games.md rework (#1192) 2023-10-27 12:30:32 +02:00
apworld specification.md Docs: minor updates to recommend modern PEP8 (#2384) 2023-11-15 17:07:42 +01:00
code_of_conduct.md Docs: code_of_conduct.md (#1350) 2023-01-07 10:24:41 +01:00
contributing.md Docs: Add documentation on writing and running tests (#2348) 2023-12-01 10:26:27 +01:00
network protocol.md Docs: Better description for LocationScouts (#2674) 2024-02-22 09:49:02 +01:00
options api.md Docs: Clarify which kinds of options actually support "random" (#2845) 2024-02-24 17:01:54 +01:00
running from source.md Docs: python 3.11 works now (#2258) 2023-10-03 12:19:09 +02:00
settings api.md Core: Add settings API ("auto settings") for host.yaml (#1871) 2023-07-05 22:39:35 +02:00
style.md Docs: world api general cleanup/overhaul (#2598) 2024-01-30 21:42:33 +01:00
tests.md Docs: Add documentation on writing and running tests (#2348) 2023-12-01 10:26:27 +01:00
triage role expectations.md Docs: Triage role expectations documentation. (#2325) 2023-10-18 15:11:25 -05:00
webhost configuration sample.yaml WebHost: automatically fill PATCH_TARGET -> HOST_ADDRESS and re-use it for rooms (#1518) 2023-03-09 21:31:00 +01:00
world api.md Core: typing: return type of `fill_slot_data` to `Mapping` (#2876) 2024-02-29 02:22:42 +01:00
world maintainer.md Docs: Create `CODEOWNERS` document for tracking world maintainers. (#1901) 2023-07-27 09:12:06 -05:00