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

Some issues with the manual #5

Closed
fingolfin opened this issue Feb 11, 2025 · 5 comments
Closed

Some issues with the manual #5

fingolfin opened this issue Feb 11, 2025 · 5 comments

Comments

@fingolfin
Copy link
Member

fingolfin commented Feb 11, 2025

Overall the manual for this package looks quite nice. I only have a few minor remarks.

  1. Install instructions on https://gap-packages.github.io/ibnp/doc/chap1_mj.html talk about a .zip file that is not there, and refers to "ftp".
  2. Also the reference to "any GAP archive seems anachronistic -- we don't mirror individual package archives anymore at this time
  3. also https://www.gap-system.org/Packages/packages.html is gone in the form that is intended here; the page it redirects to doesn't seem relevant
  4. same page: the recommended way to run package tests is TestPackage("ibnp");
  5. I was confused by https://gap-packages.github.io/ibnp/doc/chap2_mj.html -- at first I thought it was part of the GBNP manual and copied over by accident. But now I think it is there as a kind of "you need to know GBNP to use IBNP so we'll recall a few basics". Is that correct? If so, I'd suggest to mention something to this effect very briefly at the start of that chapter
  6. MathJax fails to render the xy diagrams on https://gap-packages.github.io/ibnp/doc/chap3_mj.html (though I think it does support some kinds of diagrams, but not those).
@cdwensley
Copy link
Collaborator

cdwensley commented Mar 5, 2025 via email

@fingolfin
Copy link
Member Author

What about the other issues, e.g. issue #3 about the license, which seems to still be unresolved? I've also just opened another regarding that fact that this repository is locked down as "private".

@cdwensley
Copy link
Collaborator

Repository now public.
LICENSE issue now fixed (I hope).
README issues all dealt with.
Nothing outstanding?

@fingolfin
Copy link
Member Author

I made a PR earlier with a few more minor README.md changes. Other than that it looks good to me. Let me know once you made a new release.

@cdwensley
Copy link
Collaborator

Resolved in PR #7 and PR #8

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

No branches or pull requests

2 participants