Skip to content

OTP documentation lesson ordering #14559

Open
@tirimia

Description

@tirimia

Elixir and Erlang/OTP versions

Erlang/OTP 27 [erts-15.2.7] [source] [64-bit] [smp:12:12] [ds:12:12:10] [async-threads:1] [jit]

Elixir 1.18.4 (compiled with Erlang/OTP 27)

Operating system

any

Current behavior

While working my way through the elixir manual, I stumbled across an issue relating to the order of instructions.

After one learns of the --sname flag, one is asked to try starting two sessions of the kv_umbrella project as follows:

$ iex --sname foo -S mix
$ iex --sname bar -S mix

However, if no environment variable PORT is set as enabled by the instructions in a previous subchapter, the second session will throw an error.
This will also make subsequent steps and the testing part throw errors too.

Upon reading some more, turns out the next chapter covers this already but when it comes to the already packaged application.

I initially wanted to provide a pull request directly adding a note under the instructions referenced above to make sure the shell in which we run the bar session at least exports PORT as something other than 4040, but given that there is already an explanation in the later part of the chapter, I thought I'd first ask here what the best course of action would be.

P.S. I'm loving the language, docs, and all the work that has gone into this project ❤

Expected behavior

Would love a clear and concise way to instruct users of the manual to get the two iex sessions working with no unintended errors on a single machine.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions