Skip to content

Commit

Permalink
Docs link fixes (#397)
Browse files Browse the repository at this point in the history
Because they were broken/deprecated/non-existent.
  • Loading branch information
skrawcz authored Sep 28, 2023
1 parent d07fae7 commit 11f4b4c
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 4 deletions.
2 changes: 1 addition & 1 deletion contrib/docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ const config = {
items: [
{
label: 'Dataflows',
to: '/docs/intro',
to: '/docs/',
},
],
},
Expand Down
2 changes: 1 addition & 1 deletion contrib/docs/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function HomepageHeader() {
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/intro">
to="/docs/">
Integrate with your code in 5 minutes ⏱️
</Link>
</div>
Expand Down
10 changes: 10 additions & 0 deletions docs/getting-started/hamilton-hub.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Hamilton Hub
Want something off the shelf? or a place to build something from?

In three lines of code you'll be able to run pre-built dataflows!

Check out the [Hamilton Hub](https://hub.dagworks.io/?utm_source=docs) for more details.
The "Hamilton Hub" is your place for discovering and contributing Hamilton dataflows.

It's still in the early stages of being built out, so check back often
for new dataflows!
1 change: 1 addition & 0 deletions docs/getting-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,5 @@ The following section of the docs will teach you how to install Hamilton and get
install
write-first-dataflow
run-first-dataflow
hamilton-hub
next-steps
2 changes: 1 addition & 1 deletion docs/reference/result-builders/Polars.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ Polars
=======================


.. autoclass:: hamilton.plugins.polars_implementations.PolarsDataFrameResult
.. autoclass:: hamilton.plugins.h_polars.PolarsDataFrameResult
:members: build_result
2 changes: 1 addition & 1 deletion examples/polars/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Here is the graph of execution - which should look the same as the pandas exampl
There is one major caveat with Polars to be aware of: THERE IS NO INDEX IN POLARS LIKE THERE IS WITH PANDAS.

What this means is that when you tell Hamilton to execute and return a polars dataframe if you are using the
[provided results builder](https://github.com/dagworks-inc/hamilton/blob/sf-hamilton-1.14.1/hamilton/plugins/polars_implementations.py#L8), i.e. `hamilton.plugins.polars_implementations.PolarsResultsBuilder`, then you will have to
[provided results builder](https://github.com/dagworks-inc/hamilton/blob/sf-hamilton-1.14.1/hamilton/plugins/h_polars.py#L8), i.e. `hamilton.plugins.h_polars.PolarsResultsBuilder`, then you will have to
ensure the row order matches the order you expect for all the outputs you request. E.g. if you do a filter, or a sort,
or a join, or a groupby, you will have to ensure that when you ask Hamilton to materialize an output that it's in the
order you expect.
Expand Down

0 comments on commit 11f4b4c

Please sign in to comment.