Switch to doctest for Igniter.Code.Common.add_code/3

[axelson]

Fixes a typo in the existing docs and switches to doctests to ensure that the docs do not get out of date.

But I am not quite 100% convinced that this is necessarily more readable, it feels a bit awkward to me. I wish I could write a better assertion as the last line of the doctest, we could use a heredoc but then we'd have to annoyingly deal with the trailing newline.

Here's the new and old docs:

Old	New

Contributor checklist

• Bug fixes include regression tests
• Features include unit/acceptance tests

[zachdaniel]

Hmm...yeah that's interesting. The value of the secrets is pretty high even if it looks a bit less good. When you click the button to copy this do you get all the ...> also? Maybe we can clean it up by reworking the example to be single line strings in places?

[axelson]

When you click the button to copy this do you get all the ...> also? Maybe we can clean it up by reworking the example to be single line strings in places?

Clicking the button (or selecting the text directly) doesn't include the ...>. If you generate the docs with my makeup_elixir PR elixir-makeup/makeup_elixir#39 then you get:

existing_zipper = Igniter.Code.Common.parse_to_zipper!("""
IO.inspect("abc")
""")

existing_zipper
|> Igniter.Code.Common.add_code("""
IO.inspect("Goodbye, world!")
""", after: true)
|> Sourceror.Zipper.root()
|> Sourceror.to_string()
"IO.inspect(\"abc\")
IO.inspect(\"Goodbye, world!\")"

which can be directly copied and pasted to an IEx terminal that has Igniter as a dep.

But yeah it isn't really the most readable. Maybe it would make more sense to split it into two, a smaller more limited doctest and a larger by hand example (I think we could make that larger example flow a bit better than the current version on main).

[axelson]

The value of the secrets is pretty high even...

Do you mean doctest instead of secrets?

[zachdaniel]

Yes, that was autocorrect 😂

[zachdaniel]

I'm down with this. It is slightly less readable but more conventional.

[zachdaniel]

Good to merge?

[axelson]

Yeah, let's do it! 🎉