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

[joss] Testing instructions are incomplete in the documentation #145

Closed
szhorvat opened this issue Jan 19, 2024 · 1 comment
Closed

[joss] Testing instructions are incomplete in the documentation #145

szhorvat opened this issue Jan 19, 2024 · 1 comment
Assignees
@bonicim
Labels
active Work in progress joss

Comments

@szhorvat
Copy link
Contributor

szhorvat commented Jan 19, 2024 •
edited
Loading

The testing guide contains a complete list of instructions in the README, but not in the documentation, here:

https://hypernetx.readthedocs.io/en/latest/install.html#running-tests

Specifically, pip install .['testing'] is missing.

I don't think it is necessary to include testing instructions in the usage documentation (as opposed to development guide), but if you do include it, please make sure that it is complete. This is quite useful e.g. for package maintainers.

Ref: openjournals/joss-reviews#6016
@bonicim bonicim self-assigned this Jan 22, 2024
@bonicim bonicim added the joss label Jan 22, 2024
@szhorvat szhorvat mentioned this issue Jan 28, 2024
Closed
@bonicim bonicim added active Work in progress and removed backlog labels Feb 2, 2024
@bonicim
Copy link
Collaborator

bonicim commented Feb 16, 2024

Resolved in release 2.14

@bonicim bonicim closed this as completed Feb 16, 2024
bonicim added a commit that referenced this issue Apr 1, 2024
@bonicim
Pull request #145: Add HNX paper
d0a7e3d 
Merge in HYP/hypernetx from hnx-paper to develop

* commit '463d12f522dc0328dd1bcb6c7c438c4d792f3d86':
  Add HNX paper
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bonicim bonicim

Labels
active Work in progress joss
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@szhorvat @bonicim