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.

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

Documentation items for 0.3.2 #63

Closed
14 of 18 tasks
nrbgt opened this issue Mar 14, 2023 · 1 comment · Fixed by #64 or #69
Closed
14 of 18 tasks

Documentation items for 0.3.2 #63

nrbgt opened this issue Mar 14, 2023 · 1 comment · Fixed by #64 or #69
Labels
documentation Improvements or additions to documentation
Milestone
0.3.2

Comments

@nrbgt
Copy link
Contributor

nrbgt commented Mar 14, 2023 •
edited by sanbales
Loading

What I am trying to do...

Clean up documentation after #58, which needs to land to unblock other things.

How I would like to learn how to do it...

all pages

  • update icon links

per-page

  • CHANGELOG.md
  • README.md
    • update screenshots
  • CONTRIBUTING.md
    • clean up title to just "Contributing"
  • examples/Shapes.ipynb
  • reference/forces.html
    • fix some dangling "" characters after node`, etc.
  • examples/Behaviors.ipynb
    • clean up task_arrows and task_particles labels (addressed in Small Tweaks #69)
    • use fewer accordions-in-accordions
  • docs/reference/base.html
    • missing HasDimensions, etc. so downstream inheritance links are also broken

How the project might keep the docs accurate...

  • maybe find some patterns that can be statically checked
    • find all xref not inside a link (link check will find if a link is broken, but not missing)
  • maybe add some more CLI/robot tests of notebooks
    • remove old future notebooks that don't work anymore
@nrbgt nrbgt added the documentation Improvements or additions to documentation label Mar 14, 2023
@nrbgt nrbgt added this to the 0.3.0 milestone Mar 14, 2023
@nrbgt nrbgt mentioned this issue Mar 15, 2023
Merged
11 tasks
@nrbgt nrbgt closed this as completed in #64 Mar 16, 2023
@nrbgt nrbgt reopened this Mar 16, 2023
@nrbgt
Copy link
Contributor Author

nrbgt commented Mar 16, 2023

Reopening as we didn't get everything: moving to next milestone.

@nrbgt nrbgt modified the milestones: 0.3.0, 0.3.1 Mar 16, 2023
@nrbgt nrbgt changed the title Documentation items for 0.3.0 Documentation items for 0.3.1 Mar 16, 2023
@nrbgt nrbgt mentioned this issue Mar 16, 2023
Closed
33 tasks
@sanbales sanbales modified the milestones: 0.3.1, 0.2.1 Mar 17, 2023
@nrbgt nrbgt changed the title Documentation items for 0.3.1 Documentation items for 0.3.2 Mar 23, 2023
@nrbgt nrbgt pinned this issue Mar 23, 2023
@nrbgt nrbgt mentioned this issue Mar 23, 2023
Closed
33 tasks
@sanbales sanbales mentioned this issue Mar 23, 2023
Merged
10 tasks
@sanbales sanbales linked a pull request Mar 25, 2023 that will close this issue
Small Tweaks #69
Merged
10 tasks
@sanbales sanbales modified the milestones: 0.3.1, 0.3.2 Mar 25, 2023
sanbales added a commit that referenced this issue Mar 27, 2023
@sanbales
Small Tweaks (#69)
8cab9dd 
## References

Small miscellaneous tweaks, trying to address some of the issues in #63.

## Code changes

- Adds hyperbolic functions (`cosh`, `sinh`, `tanh`) and an n-dimensional hypothenuse (`hypot`) to the templating engine.
- Adds tables and explanations to the `Behaviors.ipynb` for the `jsMath` functions available when using the `Nunjucks` template.
- Adds a check for `Selection` behaviors to show up before others, throws a warning if they are not first, includes test for it.
- Preserves `LinkShape.curvature` and `LinkShape.line_dash` between `selected` and `unselected` `links` by default, e.g., set `LinkSelection.selected_curvature = None` and update the `ts` to behave appropriately.
- Fixes label for `link arrows` and `link particles` controls in `Behaviors.ipynb` (part of  #63)
- Improves `Shapes.ipynb` by adding color scales and finishing the demo controls (part of #63)
- Adds `--fix` flag to `ruff` to fix `python` code, e.g., auto-sort imports as `isort` used to do

## User-facing changes

- adds more mathematical functions available when using the `Nunjucks` template (`cosh`, `sinh`, `tanh`, and `hypot`)
  - adds better explanation for the functions and constants in the `Behaviors` notebook
- adds a warning if `node` or `link` behaviors are included in an order that can cause unexpected issues
- adds automatic UI controls for `NodeShapes` in the `Shapes` and `Behaviors` notebooks
 
## Backwards-incompatible changes

No backwards incompatible changes.
@nrbgt nrbgt closed this as completed Apr 10, 2023
@nrbgt nrbgt unpinned this issue Apr 10, 2023
nrbgt pushed a commit to nrbgt/ipyforcegraph that referenced this issue May 11, 2023
@sanbales @nrbgt
Small Tweaks (jupyrdf#69)
13c95cc 
Small miscellaneous tweaks, trying to address some of the issues in jupyrdf#63.

- Adds hyperbolic functions (`cosh`, `sinh`, `tanh`) and an n-dimensional hypothenuse (`hypot`) to the templating engine.
- Adds tables and explanations to the `Behaviors.ipynb` for the `jsMath` functions available when using the `Nunjucks` template.
- Adds a check for `Selection` behaviors to show up before others, throws a warning if they are not first, includes test for it.
- Preserves `LinkShape.curvature` and `LinkShape.line_dash` between `selected` and `unselected` `links` by default, e.g., set `LinkSelection.selected_curvature = None` and update the `ts` to behave appropriately.
- Fixes label for `link arrows` and `link particles` controls in `Behaviors.ipynb` (part of  jupyrdf#63)
- Improves `Shapes.ipynb` by adding color scales and finishing the demo controls (part of jupyrdf#63)
- Adds `--fix` flag to `ruff` to fix `python` code, e.g., auto-sort imports as `isort` used to do

- adds more mathematical functions available when using the `Nunjucks` template (`cosh`, `sinh`, `tanh`, and `hypot`)
  - adds better explanation for the functions and constants in the `Behaviors` notebook
- adds a warning if `node` or `link` behaviors are included in an order that can cause unexpected issues
- adds automatic UI controls for `NodeShapes` in the `Shapes` and `Behaviors` notebooks

No backwards incompatible changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
ipyforcegraph
Status: Done
Milestone
0.3.2
Development

Successfully merging a pull request may close this issue.

Update docs, some deps nrbgt/ipyforcegraph
Small Tweaks jupyrdf/ipyforcegraph
2 participants
@sanbales @nrbgt