Link to function in documentation

Author: samedii

datastream/dataset.py

@@ -67,8 +67,8 @@ def from_subscriptable(subscriptable) -> Dataset:
         Create ``Dataset`` based on subscriptable i.e. implements
         ``__get_item__``. Should only be used for simple examples as a
         ``Dataset`` created with this method does not support methods that
-        require a source dataframe (i.e. ``Dataset.split`` and
-        ``Dataset.subset``)
+        require a source dataframe (i.e. :func:`Dataset.split` and
+        :func:`Dataset.subset`)
         '''
         return (
             Dataset.from_dataframe(
@@ -284,7 +284,7 @@ def to_concat(dataset_index, inner_index):
     def concat(datasets: List[Dataset]) -> Dataset[R]:
         '''
         Concatenate multiple datasets together so that they behave like a
-        single dataset. Consider using ``Datastream.merge`` if you have
+        single dataset. Consider using :func:`Datastream.merge` if you have
         multiple data sources.
         '''
         from_concat_mapping = Dataset.create_from_concat_mapping(datasets)

datastream/datastream.py

@@ -33,7 +33,8 @@ class Datastream(BaseModel, Generic[T]):
     ``Datastream[T]`` combines a ``Dataset[T]`` and a sampler into a stream of
     examples. By default the samples are drawn without replacement until the
     full dataset is exhausted. The proportion of the dataset that should be
-    drawn before allowing replacement can be changed with ``.sample_proportion``.
+    drawn before allowing replacement can be changed with
+    :func:`Datastream.sample_proportion`.
 
         >>> from datastream import Dataset, Datastream
         >>> data_loader = (
@@ -176,7 +177,7 @@ def sample_proportion(
         proportion: float,
     ) -> Datastream[T]:
         '''
-        Create new ``Datastream`` with changed proportion. This changes the
+        Create new ``Datastream[T]`` with changed proportion. This changes the
         numbers of drawn samples before restarting sampling with new weights
         and allowing sample replacement.
 
@@ -195,7 +196,7 @@ def state_dict(self) -> Dict:
         return dict(sampler=self.sampler.state_dict())
 
     def load_state_dict(self, state_dict: Dict):
-        '''Load saved state from ``Datastream.state_dict``.'''
+        '''Load saved state from :func:`Datastream.state_dict`.'''
         return self.sampler.load_state_dict(state_dict['sampler'])
 
     def multi_sample(self: Datastream[T], n: int) -> Datastream[T]: