Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Things that might need to be changed:
AFAICT the docs are generated with Travis CI, but I don't think that's running anymore. Travis CI stopped free builds for public projects a while ago. Maybe the docs could be generated by appveyor? Or Github actions?
Documenter.jl has a problem with recognizing inner constructors of structs, when I tried adding e.g.
Socket(typ::Integer)
I got:Possibly related: Multiple constructors JuliaDocs/Documenter.jl#396
I got around this by copying the constructor docstrings into the type docstrings and manually separating them with horizontal lines to approximate what Documenter.jl does with method overloads:
I left the docstrings on the constructors too for the sake of clarity (though now they're duplicated so perhaps it would be better to just keep them in the type docstring).
Should fix #203.