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

Added JGraphT Algorithm Package Summary #1203

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Ru-816
Copy link

@Ru-816 Ru-816 commented Mar 2, 2024

I have created a text file, using markdown extension, where I have summarized the purpose of every algorithm contained in alg package, inside the jgrapht-core package. I did this change in order to clarify the usage of JGraphT algorithms for users.

@jsichi
Copy link
Member

jsichi commented Mar 3, 2024

Thank you for the contribution. Here are a couple of initial review comments:

  1. This information would be better placed in the package-info.html (which is currently a stub), meaning it would need to be HTML inside the Javadoc. We already have an automatically generated summary as part of the core Javadoc at https://jgrapht.org/javadoc/org.jgrapht.core/module-summary.html, but the details you've added at the alg level would be nice. In the HTML, be sure to use @link tags to reference the algorithm examples.

  2. Avoid specifying the exact number of algorithms ("4 algorithms related to...") because this is guaranteed to become out of date when someone adds a new algorithm later. Even if there's only one, just say "contains algorithms related to..."

I'll have some more detailed comments after these are addressed.

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