Skip to content

Add intro and importing docs#78

Merged
adamnsch merged 5 commits intomainfrom
more-docs
Jan 31, 2025
Merged

Add intro and importing docs#78
adamnsch merged 5 commits intomainfrom
more-docs

Conversation

@adamnsch
Copy link
Collaborator

@adamnsch adamnsch commented Jan 27, 2025

New intro section, and docs for the importers.

@adamnsch adamnsch changed the title Improve introduction section of docs Add more documentation Jan 31, 2025
@adamnsch adamnsch marked this pull request as ready for review January 31, 2025 10:37
@adamnsch adamnsch changed the title Add more documentation Add intro and importing docs Jan 31, 2025
Copy link
Collaborator

@FlorentinD FlorentinD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found a type and also realized a follow up action we need to do

Comment on lines +95 to +99
The last optional property, ``node_radius_min_max``, can be used (and is used by default) to scale the node sizes for the
visualization.
It is a tuple of two floats, representing the radii (sizes) in pixels of the smallest and largest nodes respectively in
the visualization.
This can be useful if node sizes vary a lot, or are all very small or very big.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT: could have the description shared in its own .rst file + .. include:: radius_desc.rst
not sure if even possible though

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought about that, but felt it was a bit much for this

adamnsch and others added 2 commits January 31, 2025 14:05
Co-Authored-By: Florentin Dörre <florentin.dorre@neotechnology.com>
@adamnsch adamnsch merged commit 0b4052d into main Jan 31, 2025
1 check passed
@adamnsch adamnsch deleted the more-docs branch January 31, 2025 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants