search

simphony / simphony-common

The native implementation of the Simphony cuds objects
BSD 2-Clause "Simplified" License
7 stars 5 forks source link

"Containers" versus "Datasets" in documenation #242

Open nathanfranklin opened 8 years ago

nathanfranklin commented 8 years ago

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 https://github.com/simphony/simphony-common/blob/1431d09344c2a4786caca4b190b7c3dede021992/simphony/cuds/abc_modeling_engine.py#L33-L34 would be changed to:

def add_dataset(self, dataset
"""Add a CUDS dataset
ahashibon commented 8 years ago

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

mehdisadeghi commented 8 years ago

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