Repository navigation
Deprecations Plans #675
Becheler
started this conversation in
API & Usability
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Hi Boost.Graph community !
Plans for deprecating parts of the BGL have so far been scattered across PRs, issues and private conversations. @andreacassioli recently asked whether there was a single place documenting them, and there wasn't. This discussion is meant to fix that: one public place to describe the direction, explain the constraints, and collect feedback.
Note that some deprecations will still originate in PRs: occasionally a change simply can't be made without deprecating an existing interface. When that happens, the PR will link back here.
Long term direction
Over time, we plan to deprecate:
labeled_graphandnamed_graphinto a single documented component #465boost::graphnamespaceThis is the overall direction, not a schedule. What actually gets deprecated in a given Boost release will be listed in that release's notes.
How the migration will work
Nothing will ever break suddenly (unless we did it wrong). Users will have 2 full release cycles to prepare migration between the deprecation notice and the removal of the deprecated feature.
The namespace/named-parameters migration is the trickiest part, and it constrains everything else:
boost::graph, and only once they exist will the correspondingboost::named parameter overloads be deprecated.Deprecation PRs list
Deprecation PRs are marked with the
deprecationlabel, allowing for easy filtering:https://github.com/boostorg/graph/pulls?q=is%3Apr+state%3Aopen+state%3Aclosed+label%3Adeprecation
Feedback welcome
If any of this affects your code, or if you see something that should be on (or off) this list, please comment below. Knowing which interfaces people rely on helps us prioritize and plan migration paths. Thanks @andreacassioli for motivating this discussion 😄
All reactions