Document how the dirty __eq__ is called

[Marco-Kaulea]

Closes #38

[codecov]

Codecov Report

Merging #41 (b9a63b4) into main (2d3c0e5) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main       #41   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           11        11           
  Lines          660       660           
  Branches       167       167           
=========================================
  Hits           660       660           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2d3c0e5...b9a63b4. Read the comment docs.

[samuelcolvin]

Thanks so much for investigating this.

Arguably this belongs more in the docs than in the readme, but I'm happy for it to be included in both. Please could you copy or move this into docs/index.md or a new file in docs.

Please could you also wrap this content to match the style of the rest of the readme and docs.

[Marco-Kaulea]

I wasn't sure where to put it initially, so the bottom of the README seemed as good a place as any. But on second though it's probably not important enough.

I hope the line wrapping is OK this way, that was my editor default.

[samuelcolvin]

Some more typos :-)

[samuelcolvin]

You need to add internals.md to mkdocs.yml, you can see in the preview that the file isn't rendered. You might also want to change the heading levels to 1 and 2.

[samuelcolvin]

or you can add this content to the bottom of index.md, whichever you prefer.

[Marco-Kaulea]

No idea where I can find the current preview. I hope this works now.
Either way, I'm off of work now and might not check back in for a while.

[samuelcolvin]

See "smokeshow / docs — Docs Preview" in the "Checks".

That looks great, thank you so much.