Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.

"Containers" versus "Datasets" in documenation #242

Open
nathanfranklin opened this issue Dec 2, 2015 · 2 comments
Open

"Containers" versus "Datasets" in documenation #242

nathanfranklin opened this issue Dec 2, 2015 · 2 comments
Assignees
Labels
Milestone

Comments

@nathanfranklin
Copy link
Member

In the sphinx documentation as well as in many docstrs, we use the terms data set ("dataset") and container (e.g. "CUDS container") when referring to either ABCMesh, ABCParticles or ABCLattice.

Examples:

Could we unify the two terms? For example, could we switch all the uses of "containers" to "dataset"?

So

def add_dataset(self, container):
"""Add a CUDS container
would be changed to:

def add_dataset(self, dataset
"""Add a CUDS dataset
@ahashibon
Copy link
Contributor

A very good point!
I agree. We should switch to DataSet. It is proposed in the coming D1.6.

@roigcarlo roigcarlo added this to the 0.3.1 milestone Dec 11, 2015
@roigcarlo roigcarlo self-assigned this Dec 11, 2015
@mehdisadeghi
Copy link
Contributor

I remove this issue from the milestone as it should be addressed along with other changes in the next one.

@mehdisadeghi mehdisadeghi removed this from the 0.3.1 milestone Jun 9, 2016
@dpinte dpinte added this to the Cleanup milestone Jul 27, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

5 participants