Skip to content

Commit

Permalink
Fixed typo in stitching-api.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yoid2000 committed Oct 18, 2024
1 parent d04c87c commit dc5eb36
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/stitching-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ df_stitched = stitch(df_left=df_left, df_right=df_right, shared=False)

`df_left` and `df_right` are dataframes. They must have at least one column in common. Stitching will take place on the common columns. `df_stitched` will contain the common columns as well as the non-common columns from both `df_left` and `df_right`. `df_left` and `df_right` do not need to have the same number of rows, but in practice they should not differ by more than a few rows. Otherwise, the quality of `df_stitched` will be poor (many dropped or replicated rows from `df_left` and `df_right`).

`shared` is `True` be default. If `shared==False`, then the common columns in `df_left` will be preserved in `df_stitched`: they will not be modified by the stitching procedure. If `shared==True`, then the common columns in both `df_left` and `df_right` will be modified.
`shared` is `True` by default. If `shared==False`, then the common columns in `df_left` will be preserved in `df_stitched`: they will not be modified by the stitching procedure. If `shared==True`, then the common columns in both `df_left` and `df_right` will be modified.

Examples of stitching can be found at `tests/test_stitcher.py`.

0 comments on commit dc5eb36

Please sign in to comment.