Skip to content

Conversation

@RaoulLuque
Copy link
Member

@RaoulLuque RaoulLuque commented Jul 27, 2025

This PR implements two quick Doc fixes as well as different smaller fixes:

  • The link in the lib.rs docs was to functions in the algo module, instead of the top level index.html
  • The top-level index.html in the algo module seemed very bare-bone, therefore I added a little bit of text instead of none
  • Adds examples for different functions like map and filter_map are added.

@RaoulLuque RaoulLuque added A-documentation Area: Docs S-waiting-on-review Status: Awaiting review from the assignee but also other interested parties labels Jul 27, 2025
@RaoulLuque RaoulLuque added this to the 0.8.3 milestone Jul 29, 2025
@starovoid
Copy link
Collaborator

Hi! I see such mini doc fixes occur too often, how about leaving this one PR before the release and adding all new fixes to it? I'm a little worried about overloading the changelog :)

@RaoulLuque
Copy link
Member Author

RaoulLuque commented Jul 31, 2025

On the one hand I agree with you, however on the other I also think that it is fine to have a long list of doc fixes in the changelog. Since the changelog is split into sections, I feel like it doesn't really negatively impact the readability. However, I think it shows that we care about the docs and we put work into them :) But I am happy to use this PR to consolidate future doc changes 👍

@starovoid
Copy link
Collaborator

Hi @RaoulLuque , could you include #875 in the current PR? Of course, with the preservation of authorship.

@RaoulLuque RaoulLuque force-pushed the cleanup_top_level_algo_docs branch from 5182775 to 67ee894 Compare September 3, 2025 13:02
@RaoulLuque RaoulLuque force-pushed the cleanup_top_level_algo_docs branch from ee70cbc to 8aeefce Compare September 14, 2025 14:01
@RaoulLuque RaoulLuque added C-tracking-issue An issue/PR that collects information about a broad development initiative and removed S-waiting-on-review Status: Awaiting review from the assignee but also other interested parties labels Sep 19, 2025
@RaoulLuque RaoulLuque changed the title docs: Fix Algo Module Docs docs: Collection of Doc fixes Sep 19, 2025
@RaoulLuque RaoulLuque force-pushed the cleanup_top_level_algo_docs branch from 07cebd9 to 16a9846 Compare September 22, 2025 07:21
@RaoulLuque RaoulLuque force-pushed the cleanup_top_level_algo_docs branch from 16ec1d0 to 129661b Compare September 28, 2025 19:10
@RaoulLuque RaoulLuque added this pull request to the merge queue Sep 28, 2025
Merged via the queue into petgraph:master with commit ef5d17d Sep 28, 2025
11 checks passed
@RaoulLuque RaoulLuque deleted the cleanup_top_level_algo_docs branch September 28, 2025 19:19
@github-actions github-actions bot mentioned this pull request Sep 28, 2025
github-merge-queue bot pushed a commit that referenced this pull request Sep 30, 2025
## 🤖 New release

* `petgraph`: 0.8.2 -> 0.8.3 (✓ API compatible changes)

<details><summary><i><b>Changelog</b></i></summary><p>

<blockquote>

##
[0.8.3](https://github.com/petgraph/petgraph/compare/petgraph@v0.8.2...petgraph@v0.8.3)
- 2025-09-28

### Bug Fixes

- Infinite `subgraph_isomorphisms_iter` for empty isomorphisms
([#780](#780))
- Algos don't work on `UndirectedAdaptor`
([#870](#870))
([#871](#871))
- use a queue for SPFA
([#893](#893))
- `StableGraph::reverse` breaks free lists
([#890](#890))

### Documentation

- Fix examples link in README and unify typesetting of one word
([#823](#823))
- Add link to multigraph definition to isomorphism algos
([#824](#824))
- Fix auxiliary space (and time) complexity of bron-kerbosch
([#825](#825))
- Fix Typo in Operator Module Documentation
([#831](#831))
- Sync the crate feature flags in the README and docs
([#832](#832))
- Remove all \[Generic\] tags from algo docstrings
([#835](#835))
- Fix typos in comments
([#836](#836))
- Revamp CONTRIBUTING.md
([#833](#833))
- Update `GraphMap` link in README
([#857](#857))
- Add doc comment for `Dot::with_attr_getters`
([#850](#850))
- Specify iteration order for neighbors and edges and their variants
([#790](#790))
- Collection of Doc fixes
([#856](#856))

### New Features

- Add `into_nodes_edges_iters` to `StableGraph`
([#841](#841))
- Add methods to reserve & shrink `StableGraph` capacity
([#846](#846))
- Add Dinic's Maximum Flow Algorithm
([#739](#739))
- make Csr::from_sorted_edges generic over edge type and properly
increase edge_count in Csr::from_sorted_edges
([#861](#861))
- Add `map_owned` and `filter_map_owned` for `Graph` and `StableGraph`
([#863](#863))
- Add dijkstra::with_dynamic_goal
([#855](#855))
- Fix self-loop bug in all_simple_paths and enable multiple targets
([#865](#865))
- mark petgraph::dot::Dot::graph_fmt as public
([#866](#866))
- Add bidirectional Dijkstra algorithm
([#782](#782))

### Performance

- Make A* tie break on lower h-values
([#882](#882))

### Refactor

- add examples for scc algorithms and reorganize into dedicated module
([#830](#830))
- Remove unnecessary trait bounds from impls/methods
([#828](#828))
- replace uses of 'crate::util::zip' with 'core::iter::zip'
([#849](#849))
- Fix clippy (and other) lints
([#851](#851))
- Cleanup repo ([#854](#854))
- replace crate::util::enumerate with Iterator::enumerate
([#881](#881))

### Testing

- Add dependency list for 'quickcheck' feature
([#822](#822))
- Fix feature cfg capitalization in doctest
([#852](#852))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Egor Starovoitov <52821033+starovoid@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-documentation Area: Docs C-tracking-issue An issue/PR that collects information about a broad development initiative

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants