Deprecate block ids #120
Deprecate block ids #120
Conversation
|
Going through just this first bit showed how many block_id data items we don't have; everything with a phase/diffractogram_id needs a phase/diffractogram block id, and we currently don't have them. |
cif_pow.dic
Outdated
| The _pd_phase_block.id or _pd_phase.id entry points to the CIF block with | ||
| structural parameters for each crystalline phase. | ||
| The _pd_phase.id entry points to the CIF block with structural parameters | ||
| for each crystalline phase. |
There was a problem hiding this comment.
_pd_phase.id doesn't really "point" to anything, it just identifies a phase.
There was a problem hiding this comment.
I've changed some words and moved that sentence to the actual _pd_phase.id description.
There was a problem hiding this comment.
How about "_pd_phase.id can be used to associate a block with a particular crystalline phase."
| _description.text | ||
| ; | ||
| **DEPRECATED** | ||
| Use _pd_phase.id or _pd_diffractogram.id, as necessary. | ||
|
|
There was a problem hiding this comment.
_pd_block.id is not really replaced by those other data names. _pd_block.id identifies a data block, they identify phases and diffractograms. If anything, it is replaced by _audit.block_code.
There was a problem hiding this comment.
Strictly, yes, but, the data items that were linked to _pd_block.id were only ever used to identify phases or diffractograms. I can add _audit.block_code as an option in the replacement list.
There was a problem hiding this comment.
OK, it might still confuse some people thinking that a _pd_block.id identifies a block, whereas the other ids identify something completely different. We might need to expand the explanation.
|
Regarding some of those deprecations, as we haven't had a formal release of the dictionary containing some of these items it would be OK to simply remove them, I think. |
|
I did just plain up remove a bunch. AFAIK the ones that are deprecated existed previously in one form or another. The block_id-related data items that are deprecated are
|
|
I believe that if this gets merged, we should consider going to v3.0.0 -- it's a pretty big change in how pdCIF files talk between blocks. phse_id and diffractogram_id, and no block_id. |
…owder_Dictionary into deprecate_pd_block_id
…owder_Dictionary into deprecate_pd_block_id
Just showing what it might look like.
Starting by removing block_id-related data items from new categories.
This will end by deprecating
PD_BLOCK,PD_BLOCK_DIFFRACTOGRAM, andPD_PHASE_BLOCK. (can entire categories be deprecated?, I know individual data items can be...)Needs #92 and #93 merged before it can go through fully.