Skip to content

Commit

Permalink
fixed documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Mittmich committed Nov 11, 2023
1 parent bd2b6f8 commit 8efbee9
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 5 deletions.
1 change: 1 addition & 0 deletions .github/workflows/build_pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
branches:
- master
- docs
- pages-build-fix
permissions:
contents: write
jobs:
Expand Down
2 changes: 1 addition & 1 deletion docs/dataframe_models.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Dataframe models

::: spoc.dataframe_models
::: spoc.models.dataframe_models
2 changes: 1 addition & 1 deletion docs/file_parameters_models.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# File parameter models

::: spoc.file_parameter_models
::: spoc.models.file_parameter_models
2 changes: 1 addition & 1 deletion spoc/io.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ def write_fragments(path: str, fragments: Fragments) -> None:
fragments.data.to_parquet(path, row_group_size=1024 * 1024)

@staticmethod
def load_chromosome_sizes(path: str):
def load_chromosome_sizes(path: str) -> pd.DataFrame:
"""Load chromosome sizes
Args:
Expand Down
4 changes: 2 additions & 2 deletions spoc/pixels.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ def __init__(
self._data = None

@staticmethod
def from_uri(uri, mode="path"):
def from_uri(uri, mode="path") -> "Pixels":
"""Construct pixels from uri.
Will match parameters based on the following order:
Expand Down Expand Up @@ -109,7 +109,7 @@ def from_uri(uri, mode="path"):
uri, load_dataframe=load_dataframe
)

def get_global_parameters(self):
def get_global_parameters(self) -> PixelParameters:
"""Returns global parameters of pixels
Returns:
Expand Down

0 comments on commit 8efbee9

Please sign in to comment.