From 8aa33ce12a17484667d31a538e4f5dc3ca4a43e5 Mon Sep 17 00:00:00 2001 From: Pavithra Eswaramoorthy Date: Wed, 10 Apr 2024 23:28:11 +0530 Subject: [PATCH] :broom: Fix links to old docs pages Signed-off-by: Pavithra Eswaramoorthy --- README.md | 2 +- docs/wiki/api-references/Base-Adapters-API.md | 2 +- docs/wiki/api-references/Base-Nodes-API.md | 4 ++-- docs/wiki/concepts/CSP-Graph.md | 2 +- docs/wiki/concepts/CSP-Node.md | 2 +- docs/wiki/dev-guides/Contribute.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3af71a95..1e9abd50 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ See [our wiki!](https://github.com/Point72/csp/wiki) ## Development -Check out the [Developer Documentation](https://github.com/Point72/csp/wiki/99.-Developer) +Check out the [contribution guide](https://github.com/Point72/csp/wiki/Contribute) and [local development instructions](https://github.com/Point72/csp/wiki/Local-Development-Setup). ## Authors diff --git a/docs/wiki/api-references/Base-Adapters-API.md b/docs/wiki/api-references/Base-Adapters-API.md index a72820cc..ecae3aa9 100644 --- a/docs/wiki/api-references/Base-Adapters-API.md +++ b/docs/wiki/api-references/Base-Adapters-API.md @@ -79,7 +79,7 @@ This allows you to connect an edge as a "graph output". All edges added as outputs will be returned to the caller from `csp.run` as a dictionary of `key: [(datetime, value)]` (list of datetime, values that ticked on the edge) or if `csp.run` is passed `output_numpy=True`, as a dictionary of `key: (array, array)` (tuple of two numpy arrays, one with datetimes and one with values). -See [Collecting Graph Outputs](https://github.com/Point72/csp/wiki/0.-Introduction#collecting-graph-outputs) +See [Collecting Graph Outputs](CSP-Graph#collecting-graph-outputs) Args: diff --git a/docs/wiki/api-references/Base-Nodes-API.md b/docs/wiki/api-references/Base-Nodes-API.md index 81acf4b8..ae073051 100644 --- a/docs/wiki/api-references/Base-Nodes-API.md +++ b/docs/wiki/api-references/Base-Nodes-API.md @@ -299,7 +299,7 @@ csp.dynamic_demultiplex( ) → {ts['K']: ts['T']} ``` -Similar to `csp.demultiplex`, this version will return a [Dynamic Basket](https://github.com/Point72/csp/wiki/6.-Dynamic-Graphs) output that will dynamically add new keys as they are seen. +Similar to `csp.demultiplex`, this version will return a [Dynamic Basket](Create-Dynamic-Baskets) output that will dynamically add new keys as they are seen. ## `csp.dynamic_collect` @@ -309,7 +309,7 @@ csp.dynamic_collect( ) → ts[{'K': 'T'}] ``` -Similar to `csp.collect`, this function takes a [Dynamic Basket](https://github.com/Point72/csp/wiki/6.-Dynamic-Graphs) input and returns a dictionary of the key-value pairs corresponding to the values that ticked. +Similar to `csp.collect`, this function takes a [Dynamic Basket](Create-Dynamic-Baskets) input and returns a dictionary of the key-value pairs corresponding to the values that ticked. ## `csp.drop_nans` diff --git a/docs/wiki/concepts/CSP-Graph.md b/docs/wiki/concepts/CSP-Graph.md index c84b6542..03fadb7e 100644 --- a/docs/wiki/concepts/CSP-Graph.md +++ b/docs/wiki/concepts/CSP-Graph.md @@ -84,7 +84,7 @@ result: Note that the result is a list of `(datetime, value)` tuples. -You can also use [csp.add_graph_output]() to add outputs. +You can also use [csp.add_graph_output](Base-Adapters-API#cspadd_graph_output) to add outputs. These do not need to be in the top-level graph called directly from `csp.run`. This gives the same result: diff --git a/docs/wiki/concepts/CSP-Node.md b/docs/wiki/concepts/CSP-Node.md index 229bfdc3..bf72fc32 100644 --- a/docs/wiki/concepts/CSP-Node.md +++ b/docs/wiki/concepts/CSP-Node.md @@ -155,7 +155,7 @@ basket and react to it as well as access its current value ## **Node Outputs** Nodes can return any number of outputs (including no outputs, in which case it is considered an "output" or sink node, -see [Graph Pruning](https://github.com/Point72/csp/wiki/0.-Introduction#graph-pruning)). +see [Graph Pruning](CSP-Graph#graph-pruning)). Nodes with single outputs can return the output as an unnamed output. Nodes returning multiple outputs must have them be named. When a node is called at graph building time, if it is a single unnamed node the return variable is an edge representing the output which can be passed into other nodes. diff --git a/docs/wiki/dev-guides/Contribute.md b/docs/wiki/dev-guides/Contribute.md index 7de8b8d3..453422bc 100644 --- a/docs/wiki/dev-guides/Contribute.md +++ b/docs/wiki/dev-guides/Contribute.md @@ -4,6 +4,6 @@ For **bug reports** or **small feature requests**, please open an issue on our [ For **questions** or to discuss **larger changes or features**, please use our [discussions page](https://github.com/Point72/csp/discussions). -For **contributions**, please see our [developer documentation](https://github.com/Point72/csp/wiki/99.-Developer). We have `help wanted` and `good first issue` tags on our issues page, so these are a great place to start. +For **contributions**, please see our [developer documentation](Local-Development-Setup). We have `help wanted` and `good first issue` tags on our issues page, so these are a great place to start. For **documentation updates**, make PRs that update the pages in `/docs/wiki`. The documentation is pushed to the GitHub wiki automatically through a GitHub workflow. Note that direct updates to this wiki will be overwritten.