chore: prepare repository for crates.io publication

[tekawade]

This commit prepares the repository for publication to crates.io by:

• Removing development documentation (PROGRESS.md, PROJECT_COMPLETION_PLAN.md, NEXT_STEPS.md, REVIEW_SUMMARY.md, PHASE6_PLAN.md, START_PHASE3.md, CONVERSION_PLAN.md)
• Removing empty nested sorting module in modules/searching/modules/
• Adding version specifications to all internal dependencies in Cargo.toml files
• Fixing clippy warnings:
  • Changed module-level doc comments from ///! to //!
  • Added #[derive(Debug)] to GraphGenerator and DigraphGenerator
  • Updated is_multiple_of usage in graph_generator.rs
  • Removed unused import in top_m.rs
  • Added missing module documentation in advanced/lib.rs

All tests pass (986 tests), clippy reports no warnings, formatting is correct, documentation builds successfully, and release build completes without errors.

The repository is now ready for publication to crates.io.

[gemini-code-assist]

Summary of Changes

Hello @tekawade, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on preparing the repository for publication to crates.io by performing a significant cleanup and ensuring code quality. It involves removing outdated development documentation, standardizing internal dependency versions, and resolving various clippy warnings to meet Rust's best practices. The changes ensure the codebase is robust, well-documented, and ready for public release, with all tests passing and no linting or formatting issues.

Highlights

• Repository Cleanup: Removed seven development-related markdown files, including PROGRESS.md, CONVERSION_PLAN.md, and various phase plans, streamlining the repository for public consumption.
• Dependency Versioning: Added explicit version specifications (version = "0.1.0") to all internal crate dependencies within their respective Cargo.toml files, ensuring consistent and predictable builds.
• Clippy Warning Fixes: Addressed several clippy warnings, including updating module-level documentation comments from ///! to //!, adding #[derive(Debug)] to GraphGenerator and DigraphGenerator structs, improving is_multiple_of usage, and removing an unused import in top_m.rs.
• Documentation Improvements: Enhanced module documentation by adding missing //! comments for allow_filter, block_filter, and top_m in modules/advanced/src/lib.rs.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[Copilot]

Pull Request Overview

This PR prepares the algs4-rust repository for publication to crates.io by performing essential cleanup and fixes. The changes focus on code quality improvements and removing development-only documentation.

Key Changes:

• Fixed clippy warnings including incorrect module-level doc comment syntax (///! → //!)
• Added version specifications to internal workspace dependencies for crates.io compatibility
• Removed development planning documentation (PROGRESS.md, CONVERSION_PLAN.md, etc.)
• Added missing Debug derives and module documentation
• Removed unused imports

Reviewed Changes

Copilot reviewed 23 out of 24 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
modules/strings/src/substring/longest_repeated_substring.rs	Fixed module-level doc comment syntax from ///! to //!
modules/strings/src/substring/longest_common_substring.rs	Fixed module-level doc comment syntax from ///! to //!
modules/strings/Cargo.toml	Added version 0.1.0 to internal dependencies
modules/sorting/Cargo.toml	Added version 0.1.0 to internal dependencies
modules/searching/Cargo.toml	Added version 0.1.0 to internal dependencies
modules/graphs/src/symbol_graph.rs	Fixed module-level doc comment syntax from ///! to //!
modules/graphs/src/symbol_digraph.rs	Fixed module-level doc comment syntax from ///! to //!
modules/graphs/src/graph_generator.rs	Added #[derive(Debug)] and updated to use is_multiple_of method
modules/graphs/src/digraph_generator.rs	Added #[derive(Debug)]
modules/geometry/Cargo.toml	Added version 0.1.0 to internal dependencies
modules/fundamentals/src/util/transaction.rs	Fixed module-level doc comment syntax from ///! to //!
modules/advanced/src/top_m.rs	Fixed module-level doc comment syntax and removed unused Display import
modules/advanced/src/lib.rs	Added module documentation comments for public modules
modules/advanced/src/block_filter.rs	Fixed module-level doc comment syntax from ///! to //!
modules/advanced/src/allow_filter.rs	Fixed module-level doc comment syntax from ///! to //!
modules/advanced/Cargo.toml	Added version 0.1.0 to internal dependencies
START_PHASE3.md	Removed development documentation file
REVIEW_SUMMARY.md	Removed development documentation file
PROJECT_COMPLETION_PLAN.md	Removed development documentation file
PROGRESS.md	Removed development documentation file
PHASE6_PLAN.md	Removed development documentation file
NEXT_STEPS.md	Removed development documentation file
CONVERSION_PLAN.md	Removed development documentation file

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The is_multiple_of method was stabilized in Rust 1.82.0 (October 2024). Since there's no rust-version field in the Cargo.toml, this could cause compilation errors for users with older Rust versions. Consider either:

1. Adding rust-version = "1.82.0" to the [workspace.package] section in the root Cargo.toml, or
2. Reverting to the manual check (v * k) % 2 == 0 for broader compatibility

If targeting the latest stable Rust is acceptable for this project, option 1 is recommended.

Suggested change

	if !(v * k).is_multiple_of(2) {
	if (v * k) % 2 != 0 {

[Copilot]

The is_multiple_of method was stabilized in Rust 1.82.0 (October 2024). This will cause compilation errors for users with older Rust versions. Consider adding rust-version = "1.82.0" to the [workspace.package] section in the root Cargo.toml to document this requirement, or revert to g.degree(v) % 2 != 0 for broader compatibility.

[gemini-code-assist]

Code Review

This pull request does a great job of preparing the repository for publication on crates.io. The changes correctly fix clippy warnings and update the Cargo.toml files as required.

I have a few specific suggestions in the comments to improve the accuracy of module-level documentation, which is important for a published crate.

Additionally, I noticed a couple of areas for potential improvement in the broader codebase that you might want to consider for future refactoring, although they are outside the scope of the current changes:

• In modules/advanced/src/top_m.rs, the TopM struct re-implements a min-priority queue. The algs4-fundamentals crate already provides a MinPQ. Using the existing MinPQ would reduce code duplication and simplify TopM.
• In modules/graphs/src/graph_generator.rs, the regular function uses recursion to restart the generation process if it fails. This could lead to a stack overflow on some inputs. A loop would be a more robust way to handle retries.

Overall, these are solid improvements to the project's quality and readiness for publishing.