-
Notifications
You must be signed in to change notification settings - Fork 916
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
Improve docstring for add_feed_dict
#3612
Milestone
Comments
I would consider introducing a more intuitive name, especially with newbies in mind. We can introduce the new name as an alias to ease breaking APIs. Some ideas of the top of my head:
|
+1 to @datajoely 's idea because it also moves away from mutability |
This was referenced Jun 6, 2024
7 tasks
Solved in #4009 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
In the catalog we have a method called
add_feed_dict
. Which is arguably one of the worst named methods in the public API. Unfortunately, renaming it is a breaking change. For0.20.0
we should totally rename it, but in the mean time we should add a better docstring explanation so that engineers working on this code can better understand what it does.Context
This method was added a long time ago, likely even before Kedro was called Kedro, which git blame doesn't even know about. It was added before the catalog could be loaded from
yaml
and is supposed to describe how data can be "fed" into the catalog dictionary. The term "feed_dict" might come from clojure or tensorflow lingo, nobody really remembers 🤷The text was updated successfully, but these errors were encountered: