Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #216

Merged
merged 1 commit into from
Oct 20, 2022
Merged

Update docs #216

merged 1 commit into from
Oct 20, 2022

Conversation

JamesWrigley
Copy link
Member

  • Update Documenter.jl
  • Add/fix docstrings for a bunch of functions/types
  • Expand reference page

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:

    ┌ Warning: no docs found for 'Socket(typ::Integer)' in `@docs` block in src/reference.md:7-12```@docs
    │ Socket
    │ Socket(typ::Integer)
    │ isopen
    │ close
    ```
    └ @ Documenter.Expanders ~/.julia/packages/Documenter/vylnb/src/Utilities/Utilities.jl:34

    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:
    image

    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.

- Update Documenter.jl
- Add/fix docstrings for a bunch of functions/types
- Expand reference page
@ViralBShah
Copy link
Contributor

@JamesWrigley I'm seeing this now - would it be helpful for you to have commit access here?

@ViralBShah ViralBShah merged commit 9f30c26 into JuliaInterop:master Oct 20, 2022
@JamesWrigley JamesWrigley deleted the docs branch November 21, 2022 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Empty documentation
2 participants