Skip to content

Commit

Permalink
Merge pull request #189 from Point72/pavithraes/fix-links
Browse files Browse the repository at this point in the history
Fix links that go to old docs pages
  • Loading branch information
robambalu authored and Carreau committed May 13, 2024
2 parents faee778 + e72e620 commit c51a86b
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/api-references/Base-Adapters-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions docs/wiki/api-references/Base-Nodes-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand All @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/concepts/CSP-Graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ result:

Note that the result is a list of `(datetime, value)` tuples.

You can also use [csp.add_graph_output](<https://github.com/Point72/csp/wiki/1.-Generic-Nodes-(csp.baselib)#adapters>) 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:
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/concepts/CSP-Node.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/wiki/dev-guides/Contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit c51a86b

Please sign in to comment.