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

Documentation Updates #1213

Merged
merged 5 commits into from
Apr 11, 2024
Merged

Documentation Updates #1213

merged 5 commits into from
Apr 11, 2024

Conversation

syoon2
Copy link

@syoon2 syoon2 commented Apr 9, 2024

This PR updates documentation, including:

  • removing broken/outdated links in README
  • adding module Javadocs in module-info.java
  • improving exception documentations in Javadoc

- Fix broken link to CI status badge
- Update dependency descriptions
- Update links to wiki pages
- Update links to licenses
@syoon2
Copy link
Author

syoon2 commented Apr 9, 2024

This is a bit of a tangent: I think that the module-info.java and package-info.java files should also have the license header(s) put in. Adding them is not a part of this PR (didn't want to break any of your policies before checking first) but it is worth bringing up.

@jsichi
Copy link
Member

jsichi commented Apr 10, 2024

Regarding the question of adding the license headers to the -info.java files, yes, that would be a good as a separate PR. If you do that, be sure to remove the exclusions in etc/jgrapht_checks.xml and etc/checkstyle_suppressions.xml.

Another tangent from there, it appears that jgrapht-unimi-dsi is missing from the list of updateOneModule calls in etc/updateCopyRightYear.sh. Also in etc/codeFormatter.sh.

@syoon2 syoon2 requested a review from jsichi April 11, 2024 01:45
@syoon2 syoon2 mentioned this pull request Apr 11, 2024
7 tasks
@syoon2
Copy link
Author

syoon2 commented Apr 11, 2024

Regarding the question of adding the license headers to the -info.java files, yes, that would be a good as a separate PR. If you do that, be sure to remove the exclusions in etc/jgrapht_checks.xml and etc/checkstyle_suppressions.xml.

See #1215.

@syoon2 syoon2 requested a review from jsichi April 11, 2024 07:20
@jsichi
Copy link
Member

jsichi commented Apr 11, 2024

Thanks!

@jsichi jsichi merged commit 1d22a9d into jgrapht:master Apr 11, 2024
3 checks passed
@syoon2 syoon2 deleted the docs-update branch April 11, 2024 13:43
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.

None yet

2 participants