chore: Migrate docs from EDoc to Markdown#104
Conversation
|
Preview URL: https://Benjamin-Philip.github.io/arrow-erlang-1 If the preview URL doesn't work, you may have forgotten to configure your fork repository for preview. |
There was a problem hiding this comment.
Pull request overview
This PR migrates inline Erlang module/function/type documentation from EDoc markup to Erlang/OTP’s Markdown-based documentation system, and updates the build/tooling versions required to support it.
Changes:
- Converted
arrow_arrayinline docs to-moduledoc/-docMarkdown strings. - Bumped
rebar3_ex_docto a newer version to support Markdown doc generation. - Updated GitHub Actions workflows to build/test/docs against newer Erlang/OTP and Rebar3 versions.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| src/arrow_array.erl | Migrates EDoc to Markdown using -moduledoc/-doc and updates doc formatting/content. |
| rebar.config | Updates rebar3_ex_doc plugin version to support Markdown docs. |
| .github/workflows/erlang.yml | Bumps OTP/Rebar3 versions for CI jobs. |
| .github/workflows/docs.yml | Bumps OTP/Rebar3 versions for doc generation workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 19 out of 20 changed files in this pull request and generated 20 comments.
Comments suppressed due to low confidence (2)
src/arrow_array.erl:160
#array.datais always set to a buffer or nested array (seesrc/arrow_array.hrl), so thedata/1typespec includingundefinedis inconsistent with the record definition.
-doc "Returns the data of an array.".
-spec data(Array :: array()) -> Data :: arrow_buffer:buffer() | array() | undefined.
data(Array) ->
Array#array.data.
src/arrow_array.erl:178
- Spelling: “ommitted” should be “omitted” in the
to_arrow/1documentation.
In case an array doesn't have any of the following buffers, it is ommitted.
2b074ba to
373634c
Compare
|
Rebased onto main. This is a PR where further Copilot reviews would have been helpful. It's been fairly good at catching silly spelling and grammar mistakes. Anyway, you can have a look. |
What issue does this PR close?
Closes #103.
What's Changed
Inline documentation has been migrated to markdown.
Erlang/OTP, Rebar3 and
rebar3_ex_dochave all been updated to the lateststable version in order to use the new markdown support.