Skip to content

Doc update #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
npalacioescat wants to merge 61 commits into
base: main
Choose a base branch
from
Open

Doc update #219

npalacioescat wants to merge 61 commits into from

Conversation

@npalacioescat
Copy link
Member

@npalacioescat npalacioescat commented Oct 23, 2025

Type annotations in function declaration (and not docstrings) and docstrings of all public (and some private) functions revised and in NumPy format

Fixes #197, #193

@npalacioescat
Updated docstring format and type annotations for _logging._logg
d435697
@npalacioescat
Added docstrings for _logging._check_if_installed
b715397
@npalacioescat
Formatted docstrings and type annotations in utils.transform
2101d81
@npalacioescat
Docstrings and type annotations in spatial_neighbors
24ecac9
@npalacioescat
Type annotations in utils.query_bandwidth
a68954e
@npalacioescat
Docstrings and type annotations in utils.obsm_to_adata
8d846b1
@npalacioescat
Merge branch 'main' into doc_update
8a53f42
@npalacioescat
Docs + type annotations on mdata_to_anndata
e90505c
@npalacioescat
Type annotations on utils.interpolate_data
cfd53b3
@npalacioescat
Type annotations in utils._getters
e4b98f1
@npalacioescat
Type annotations and docstrings for resource._orthology
3fc1a7e
@npalacioescat
Type annotations and docstrings for _reassemble_complexes
d5efe48
@npalacioescat
Type annotations on _resource_utils.generate_lr_geneset
f09265e
@npalacioescat
Type annotations and docstrings for get_metalinks
f675b10
@npalacioescat
Type annotations and docstrings for plotting._tileplot
6d4f5e0
@npalacioescat
Swapped type annotations for callables
645038a
@npalacioescat
Type annotations and docstrings for plotting._misty_plots
caf819b
@npalacioescat
Type annotations + docstrings in plotting._dotplot
087aa8c
@npalacioescat
Type annotations and docstrings for plotting._connectivity_plot
68d617e
@npalacioescat
Type annotations and docstrings for plotting._circle_plot
458abf4
@npalacioescat
Type annotations and docstrings for multi.to_tensor_c2c
89aa13d
@npalacioescat
Type annotations and docstrings for multi.to_mudata
60cdc18
@npalacioescat
Type annotations and docstrings for multi.df_to_lr
a52d0b1
@npalacioescat
Type annotations and docstrings for multi._nmf
de5eb20
@npalacioescat
Type annotations and docstrings for method.__init__
f035d7a
@npalacioescat
Type annotations and docstrings for SingleViewModel base class
649fa0d
@npalacioescat
Type annotations and docstrings for RandomForestModel
9292d32
@npalacioescat
Type annotations and docstrings for LinearModel and `RobustLinearMo…
88f9aec 
…del`
@npalacioescat
Type annotations and docstrings for MistyData
55157e7
@npalacioescat
Type annotations and docstrings for _misty._misty_constructs
b031bd3
@npalacioescat npalacioescat added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 23, 2025
@npalacioescat
Copy link
Member Author

npalacioescat commented Oct 24, 2025 •
edited
Loading

@dbdimitrov there seems to be some circular import:
ImportError: cannot import name 'liana_pipe' from partially initialized module 'liana.method.sc._liana_pipe' (most likely due to a circular import)
Have you encountered this before?

@dbdimitrov
Copy link
Collaborator

dbdimitrov commented Oct 27, 2025

Hi @npalacioescat, hmm no haven't - I will have a look soon

@npalacioescat npalacioescat self-assigned this Nov 18, 2025
@npalacioescat npalacioescat mentioned this pull request Nov 18, 2025
Closed
@npalacioescat
Copy link
Member Author

npalacioescat commented Nov 18, 2025

@dbdimitrov tests all green :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dbdimitrov dbdimitrov Awaiting requested review from dbdimitrov

At least 1 approving review is required to merge this pull request.

Assignees

@npalacioescat npalacioescat

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Stick to one docstring format

3 participants

@npalacioescat @dbdimitrov