Skip to content
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.

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

Improving docs or examples #193

Open
3 tasks
marimeireles opened this issue Nov 27, 2020 · 5 comments
Open
3 tasks

Improving docs or examples #193

marimeireles opened this issue Nov 27, 2020 · 5 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@marimeireles
Copy link
Collaborator

marimeireles commented Nov 27, 2020

Ian and I are always saying "Oh, it'd be great to have this example in our docs!" but because we can't always add them immediately we don't and we end up losing them. This issue is an effort to document these little good snippets that we wish we had to someday actually add them to our docs.

Please feel free to drop yours in the comments :)
Just add a sentence (or more) explaining what the example is about.

@marimeireles marimeireles added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 27, 2020
@ianhi
Copy link
Collaborator

ianhi commented Nov 27, 2020

@joseberlines
Copy link
Contributor

talking about layouts.... what about a list of the different layouts somewhere?
here: https://js.cytoscape.org/#cy.layout there is not such list neither.

@krassowski
Copy link
Contributor

krassowski commented Dec 2, 2020

So there is an example which I would probably enjoy seeing in the docs as it took me a while to figure it out (btw the gif in README is outdated), this is changing layout on the fly and using the exact positions of nodes (no layout). I even wonder if it would make sense to make name=None to act like name='preset' (with default being whatever is being used by default at the moment).

kegg_example

Code in:

of note, in current examples the redraw currently happens on every callback, but it could only happen on if event['name'] != 'value': (I think that @ianhi mentioned this earlier elsewhere).

Edit: for simplicity I herby license the code of my example as CC0 and allow re-licensing to the current ipycytoscape license if someone wants to pick up and send a PR with this as a (modified?) example.

@joseberlines
Copy link
Contributor

@krassowski this is sooooo cool

@marimeireles
Copy link
Collaborator Author

Thank you for this adition @krassowski is super! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants