Skip to content

Replace "data space" in docstrings with new definitions #809

Open
@cbkerr

Description

@cbkerr

Description

It's an ill-defined term.

What are the differences in semantics between "project workspace" and "project data space"? Or are they synonyms?

@joaander I've found 2 definitions of "data space" in the docs:

Synonymous: all files stored in the jobs in the workspace of the project - (source: Project.create_linked_view)

Not synonymous: the abstract set of all initalized state points (source: Concepts Page) This is in the process of being fixed in glotzerlab/signac-docs#120.
The following link implies that the data space can be changed by changing the value of a state point: https://docs.signac.io/en/latest/examples/notebooks/signac_104_Modifying_the_Data_Space.html This contrasts with the first definition because changing the state point (and therefore the job id) does not remove the files stored in that job directory, and therefore wouldn't change a linked view (like what you get from the signac view command)
#743 (comment)

How to fix

Replace with "workspace" if it means the files in the workspace of a project.

Replace with ???? if it refers to the abstract idea of all data that could go in a project.

For context, see:

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationWriting or editing documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions