chore: Migrate docs from EDoc to Markdown#104
Draft
Benjamin-Philip wants to merge 6 commits into
Draft
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. |
Contributor
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.
| Array#array.len. | ||
|
|
||
| %% @doc Returns the length of an array. | ||
| -doc "Returns the length of an array.". |
Comment on lines
+163
to
+180
| -doc """ | ||
| Serializes an array into the Arrow binary form. | ||
|
|
||
| Serializes the buffers of an Array and concatenates them in the following | ||
| order: | ||
|
|
||
| 1. `validity` | ||
| 2. `offsets` | ||
| 3. `data` | ||
|
|
||
| In case an array doesn't have any of the following buffers, it is ommitted. | ||
| (e.g. validity in arrays with a null count of 0, offsets in fixed primitive | ||
| arrays). In the case of a nested array, `data` will be serialized form of nested | ||
| array. | ||
|
|
||
| Do note that this is just binary form that includes the buffers in an Array, | ||
| and not IPC. | ||
| """. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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.