Merge pull request #223 from lucasimi/doc-improvements

Improved docs. Updated version

Author: lucasimi

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tda-mapper"
-version = "0.11.0"
+version = "0.11.1"
 description = "A simple and efficient Python implementation of Mapper algorithm for Topological Data Analysis"
 readme = "README.md"
 authors = [{ name = "Luca Simi", email = "lucasimi90@gmail.com" }]

src/tdamapper/_plot_plotly.py

@@ -57,7 +57,7 @@ def plot_plotly(
  mapper_plot,
  width: int,
  height: int,
- node_size: Optional[Union[int, List[int]]] = DEFAULT_NODE_SIZE,
+ node_size: Optional[Union[int, float, List[Union[int, float]]]] = DEFAULT_NODE_SIZE,
  colors=None,
  title: Optional[Union[str, List[str]]] = None,
  agg=np.nanmean,

src/tdamapper/plot.py

@@ -167,8 +167,10 @@ def plot_plotly(
  node in the graph, useful for highlighting different features of
  the data.
  :type colors: array-like of shape (n,) or list-like of size n
- :param node_size: A scaling factor for node size. Defaults to 1.
- :type node_size: float, optional
+ :param node_size: A scaling factor for node size. When node_size is a
+ list, the figure will display a slider with the specified values.
+ Defaults to 1.
+ :type node_size: int, float or list, optional
  :param agg: A function used to aggregate the `colors` array over the
  points within a single node. The final color of each node is
  obtained by mapping the aggregated value with the colormap `cmap`.