jwalsh / jwalsh/hy-algorithms

Create comprehensive documentation for algorithm selection

Open
#8 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
Hy
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Develop detailed documentation to guide users in selecting the appropriate algorithm for their use case:

## Documentation Components:
1. Algorithm selection flowcharts by category:
- Sorting algorithms
- Searching algorithms
- Graph traversal
- String matching
- Dynamic programming approaches

2. Comparison tables with:
- Time complexity (best/average/worst)
- Space complexity
- Stability
- In-place vs. not in-place
- Parallelizability
- Input sensitivity

3. Use case recommendations:
- Data size considerations
- Input distribution considerations
- Special case optimizations

4. Implementation notes specific to Hy:
- Performance characteristics in Hy vs. other languages
- Hy-specific optimizations
- Integration with Python ecosystem

This comprehensive documentation will serve as a valuable reference for users when deciding which algorithm to use for specific problems.

Contributor guide

Open the contributing guide

Research direction

The issue names no files or tests, so first locate the repository's existing algorithm implementations and documentation structure. Define the flowcharts, comparison tables, use-case guidance, and Hy/Python integration notes across the listed algorithm categories. Done means all requested categories and comparison criteria are documented with actionable selection guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.