From a5e5f0e6158545b9e5ae4d00ebd54d60757ef036 Mon Sep 17 00:00:00 2001 From: Jefffrey <22608443+Jefffrey@users.noreply.github.com> Date: Tue, 25 Oct 2022 23:46:57 +1100 Subject: [PATCH] Fix broken links in contributor guide --- docs/source/contributor-guide/index.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/source/contributor-guide/index.md b/docs/source/contributor-guide/index.md index 748bc599f4a0..ee0bc7660d37 100644 --- a/docs/source/contributor-guide/index.md +++ b/docs/source/contributor-guide/index.md @@ -83,7 +83,7 @@ Tests for the code in an individual module are defined in the same source file w ### Rust Integration Tests -There are several tests of the public interface of the DataFusion library in the [tests](https://github.com/apache/arrow-datafusion/tree/master/datafusion/core/tests) directory. +There are several tests of the public interface of the DataFusion library in the [tests](../../../datafusion/core/tests) directory. You can run these tests individually using a command such as @@ -91,11 +91,11 @@ You can run these tests individually using a command such as cargo test -p datafusion --tests sql_integration ``` -One very important test is the [sql_integration](https://github.com/apache/arrow-datafusion/blob/master/datafusion/core/tests/sql_integration.rs) test which validates DataFusion's ability to run a large assortment of SQL queries against an assortment of data setups. +One very important test is the [sql_integration](../../../datafusion/core/tests/sql_integration.rs) test which validates DataFusion's ability to run a large assortment of SQL queries against an assortment of data setups. ### SQL / Postgres Integration Tests -The [integration-tests](https://github.com/apache/arrow-datafusion/blob/master/datafusion/integration-tests) directory contains a harness that runs certain queries against both postgres and datafusion and compares results +The [integration-tests](../../../integration-tests) directory contains a harness that runs certain queries against both postgres and datafusion and compares results #### setup environment @@ -154,7 +154,7 @@ Criterion integrates with Cargo's built-in [benchmark support](https://doc.rust- cargo bench --bench BENCHMARK_NAME ``` -A full list of benchmarks can be found [here](../../../datafusion/benches). +A full list of benchmarks can be found [here](../../../datafusion/core/benches). _[cargo-criterion](https://github.com/bheisler/cargo-criterion) may also be used for more advanced reporting._ @@ -187,7 +187,7 @@ Below is a checklist of what you need to do to add a new scalar function to Data - [here](../../../datafusion/physical-expr/src/math_expressions.rs) for math functions - [here](../../../datafusion/physical-expr/src/datetime_expressions.rs) for datetime functions - create a new module [here](../../../datafusion/physical-expr/src) for other functions -- In [core/src/physical_plan](../../../datafusion/core/src/physical_plan/functions.rs), add: +- In [physical-expr/src](../../../datafusion/physical-expr/src/functions.rs), add: - a new variant to `BuiltinScalarFunction` - a new entry to `FromStr` with the name of the function as called by SQL - a new line in `return_type` with the expected return type of the function, given an incoming type @@ -197,8 +197,6 @@ Below is a checklist of what you need to do to add a new scalar function to Data - In [core/tests/sql](../../../datafusion/core/tests/sql), add a new test where the function is called through SQL against well known data and returns the expected result. - In [expr/src/expr_fn.rs](../../../datafusion/expr/src/expr_fn.rs), add: - a new entry of the `unary_scalar_expr!` macro for the new function. -- In [core/src/logical_plan/mod](../../../datafusion/core/src/logical_plan/mod.rs), add: - - a new entry in the `pub use expr::{}` set. ## How to add a new aggregate function @@ -221,7 +219,7 @@ Below is a checklist of what you need to do to add a new aggregate function to D ## How to display plans graphically The query plans represented by `LogicalPlan` nodes can be graphically -rendered using [Graphviz](http://www.graphviz.org/). +rendered using [Graphviz](https://www.graphviz.org/). To do so, save the output of the `display_graphviz` function to a file.: @@ -250,8 +248,8 @@ new specifications as you see fit. Here is the list current active specifications: -- [Output field name semantic](https://arrow.apache.org/datafusion/specification/output-field-name-semantic.html) -- [Invariants](https://arrow.apache.org/datafusion/specification/invariants.html) +- [Output field name semantic](https://arrow.apache.org/datafusion/contributor-guide/specification/output-field-name-semantic.html) +- [Invariants](https://arrow.apache.org/datafusion/contributor-guide/specification/invariants.html) All specifications are stored in the `docs/source/specification` folder.