Skip to content

chore: Migrate docs from EDoc to Markdown#104

Merged
kou merged 18 commits into
apache:mainfrom
Benjamin-Philip:bp/markdown-docs
Jul 21, 2026
Merged

chore: Migrate docs from EDoc to Markdown#104
kou merged 18 commits into
apache:mainfrom
Benjamin-Philip:bp/markdown-docs

Conversation

@Benjamin-Philip

@Benjamin-Philip Benjamin-Philip commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

What issue does this PR close?

Closes #103.

What's Changed

Inline documentation has been migrated to markdown.

Erlang/OTP, Rebar3 and rebar3_ex_doc have all been updated to the latest
stable version in order to use the new markdown support.

Copilot AI review requested due to automatic review settings July 14, 2026 13:16
@Benjamin-Philip
Benjamin-Philip marked this pull request as draft July 14, 2026 13:17
@github-actions

Copy link
Copy Markdown

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.
See https://github.com/apache/arrow-erlang/blob/main/CONTRIBUTING.md#forks for instructions on how to configure.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_array inline docs to -moduledoc/-doc Markdown strings.
  • Bumped rebar3_ex_doc to 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.

Comment thread src/arrow_array.erl Outdated
Comment thread src/arrow_array.erl Outdated
Comment thread src/arrow_array.erl
Comment thread .github/workflows/erlang.yml Outdated
Comment thread .github/workflows/erlang.yml Outdated
Comment thread .github/workflows/erlang.yml Outdated
Comment thread .github/workflows/docs.yml Outdated
@Benjamin-Philip
Benjamin-Philip marked this pull request as ready for review July 19, 2026 14:32
Copilot AI review requested due to automatic review settings July 19, 2026 14:32

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.data is always set to a buffer or nested array (see src/arrow_array.hrl), so the data/1 typespec including undefined is 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/1 documentation.
In case an array doesn't have any of the following buffers, it is ommitted.

Comment thread src/arrow_variable_list_array.erl Outdated
Comment thread src/arrow_ipc_file.erl
Comment thread src/arrow_type.erl Outdated
Comment thread src/arrow_type.erl Outdated
Comment thread src/arrow_type.erl Outdated
Comment thread src/arrow_ipc_schema.erl Outdated
Comment thread src/arrow_ipc_record_batch.erl Outdated
Comment thread src/arrow_ipc_record_batch.erl
Comment thread src/arrow_ipc_record_batch.erl Outdated
Comment thread src/arrow_fixed_list_array.erl Outdated
Copilot AI review requested due to automatic review settings July 20, 2026 13:05

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@Benjamin-Philip
Benjamin-Philip requested a review from kou July 20, 2026 14:24
@Benjamin-Philip

Copy link
Copy Markdown
Collaborator Author

@kou, I'll rebase on main once you merge #108. Hopefully we should have the CI
working again (and the docs re-deployed for this PR instead of #108) after that.

Copilot AI review requested due to automatic review settings July 21, 2026 02:32

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@Benjamin-Philip

Copy link
Copy Markdown
Collaborator Author

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.

@kou kou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@kou
kou merged commit 89b3629 into apache:main Jul 21, 2026
11 checks passed
@Benjamin-Philip
Benjamin-Philip deleted the bp/markdown-docs branch July 21, 2026 05:49
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.

Migrate to markdown documentation

3 participants