hablapps / doric

Type safety for spark columns
https://www.hablapps.com/doric/
Apache License 2.0
77 stars 11 forks source link

Issue-235: Fix Documentation not showing up on the website #343

Closed Amalicia closed 1 year ago

Amalicia commented 1 year ago

This PR adjusts the method scopes in order to allow Scaladoc to correctly generate documentation.

Description

TODO

Related Issue and dependencies

How Has This Been Tested?

codecov[bot] commented 1 year ago

Codecov Report

Merging #343 (a463104) into main (5fe194b) will not change coverage. The diff coverage is n/a.

Additional details and impacted files [![Impacted file tree graph](https://codecov.io/gh/hablapps/doric/pull/343/graphs/tree.svg?width=650&height=150&src=pr&token=N7ZXUXZX1I&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps)](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps) ```diff @@ Coverage Diff @@ ## main #343 +/- ## ======================================= Coverage 97.60% 97.60% ======================================= Files 62 62 Lines 1249 1249 Branches 18 18 ======================================= Hits 1219 1219 Misses 30 30 ``` | Flag | Coverage Δ | | |---|---|---| | spark-2.4.x | `94.66% <ø> (ø)` | | | spark-3.0.x | `96.74% <ø> (ø)` | | | spark-3.1.x | `97.48% <ø> (ø)` | | | spark-3.2.x | `97.70% <ø> (ø)` | | | spark-3.3.x | `97.70% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps) | Coverage Δ | | |---|---|---| | [core/src/main/scala/doric/sem/JoinOps.scala](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps#diff-Y29yZS9zcmMvbWFpbi9zY2FsYS9kb3JpYy9zZW0vSm9pbk9wcy5zY2FsYQ==) | `100.00% <ø> (ø)` | | | [...c/main/scala/doric/syntax/AggregationColumns.scala](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps#diff-Y29yZS9zcmMvbWFpbi9zY2FsYS9kb3JpYy9zeW50YXgvQWdncmVnYXRpb25Db2x1bW5zLnNjYWxh) | `100.00% <ø> (ø)` | | | [...ore/src/main/scala/doric/syntax/ArrayColumns.scala](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps#diff-Y29yZS9zcmMvbWFpbi9zY2FsYS9kb3JpYy9zeW50YXgvQXJyYXlDb2x1bW5zLnNjYWxh) | `100.00% <ø> (ø)` | | | [...re/src/main/scala/doric/syntax/BinaryColumns.scala](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps#diff-Y29yZS9zcmMvbWFpbi9zY2FsYS9kb3JpYy9zeW50YXgvQmluYXJ5Q29sdW1ucy5zY2FsYQ==) | `100.00% <ø> (ø)` | | | [...e/src/main/scala/doric/syntax/BooleanColumns.scala](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps#diff-Y29yZS9zcmMvbWFpbi9zY2FsYS9kb3JpYy9zeW50YXgvQm9vbGVhbkNvbHVtbnMuc2NhbGE=) | `100.00% <ø> (ø)` | | | [...re/src/main/scala/doric/syntax/CommonColumns.scala](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps#diff-Y29yZS9zcmMvbWFpbi9zY2FsYS9kb3JpYy9zeW50YXgvQ29tbW9uQ29sdW1ucy5zY2FsYQ==) | `100.00% <ø> (ø)` | | | [...rc/main/scala/doric/syntax/ControlStructures.scala](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps#diff-Y29yZS9zcmMvbWFpbi9zY2FsYS9kb3JpYy9zeW50YXgvQ29udHJvbFN0cnVjdHVyZXMuc2NhbGE=) | `100.00% <ø> (ø)` | | | [core/src/main/scala/doric/syntax/DStructs.scala](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps#diff-Y29yZS9zcmMvbWFpbi9zY2FsYS9kb3JpYy9zeW50YXgvRFN0cnVjdHMuc2NhbGE=) | `100.00% <ø> (ø)` | | | [core/src/main/scala/doric/syntax/DateColumns.scala](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps#diff-Y29yZS9zcmMvbWFpbi9zY2FsYS9kb3JpYy9zeW50YXgvRGF0ZUNvbHVtbnMuc2NhbGE=) | `100.00% <ø> (ø)` | | | [...c/main/scala/doric/syntax/LiteralConversions.scala](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps#diff-Y29yZS9zcmMvbWFpbi9zY2FsYS9kb3JpYy9zeW50YXgvTGl0ZXJhbENvbnZlcnNpb25zLnNjYWxh) | `100.00% <ø> (ø)` | | | ... and [13 more](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps) | | ------ [Continue to review full report in Codecov by Sentry](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps). Last update [5fe194b...a463104](https://codecov.io/gh/hablapps/doric/pull/343?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=hablapps).
github-actions[bot] commented 1 year ago

:octocat: This is an auto-generated comment created by:

Actor Triggering actor Sender
eruizalo
eruizalo
eruizalo
eruizalo
eruizalo
eruizalo
Triggered by: - Workflow name: "CI" at .github/workflows/ci.yml - URL: [https://github.com/hablapps/doric/actions/runs/4773917416](https://github.com/hablapps/doric/actions/runs/4773917416) - on workflow_run:completed

Test summary report 📊

Spark version testing
2.4.1 623 passed, 2 skipped
2.4.2 623 passed, 2 skipped
2.4.3 623 passed, 2 skipped
2.4.4 623 passed, 2 skipped
2.4.5 623 passed, 2 skipped
2.4.6 624 passed, 2 skipped
2.4.7 624 passed, 2 skipped
2.4 624 passed, 2 skipped
3.0.0 674 passed, 2 skipped
3.0.1 674 passed, 2 skipped
3.0.2 674 passed, 2 skipped
3.0 674 passed, 2 skipped
3.1.0 702 passed, 2 skipped
3.1.1 702 passed, 2 skipped
3.1.2 702 passed, 2 skipped
3.1 702 passed, 2 skipped
3.2.0 706 passed, 2 skipped
3.2.1 706 passed, 2 skipped
3.2.2 706 passed, 2 skipped
3.2 706 passed, 2 skipped
3.3.0 706 passed, 2 skipped
3.3.1 706 passed, 2 skipped
3.3 706 passed, 2 skipped