-
Notifications
You must be signed in to change notification settings - Fork 36
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
Rename root
parameter for all Project
methods to path
#757
Comments
Consider also replacing |
I'm looking into this issue. |
I opened #758 to address this. |
Can we close this issue now? |
I think all the public APIs are fixed, based on the docs: https://docs.signac.io/projects/core/en/next/search.html?q=root&check_keywords=yes&area=default There are a few lingering uses of the name "root" or "root directory" but they're in the context of import/export or migrations but they're typically used for walking a filesystem, not a project path, so I don't think this naming guidance applies. There are also references to "root" in the context of synced collections, like the root of a collection, but those certainly don't need to be changed. Marking as closed unless others wish to make further refactors. |
For consistency with the new terminology that we're standardizing on for both
Job
andProject
, we should rename theroot
parameters ofProject
methods topath
. This change affectsget_project
andinit_project
, as well as theProject
constructor. Since we're moving forward with the breaking changes in #752, w should also change the signature ofinit_project
to not requirepath
to be a keyword-only argument. There may be other related changes as well that we need to consider, but I don't think there is any way to construct e.g. aJob
at a specific path (we always construct byid
orstatepoint
so I can't think of anything else that I might be missing right now.Original comment
Do we want to keep the requirement that
root
is a keyword-only argument? All our previous discussions about compatibility layers are somewhat moot now, so I would be willing to revisit that.It could even be named
path
for consistency with the new terminology. The more I think about it, it'd be really nice to call itpath
. :)Originally posted by @bdice in #752 (comment)
The text was updated successfully, but these errors were encountered: