search

COMCIFS / TopoCif

Development of the Topology CIF Dictionary
6 stars 6 forks source link

Slightly rename several data items #47

Closed vaitkus closed 3 years ago

vaitkus commented 3 years ago

Changes proposed in this issue are purely cosmetic. The names of several data items could be improved to better match the overall naming style of the dictionaries. Proposals:

Are these changes acceptable?

[1] https://www.doi.org/10.1039/B910671E

BobHanson commented 3 years ago

Letting Vlad call that one. These are all Topos legacy items.

On Mon, Sep 13, 2021 at 7:17 PM Antanas Vaitkus @.***> wrote:

Changes proposed in this issue are purely cosmetic. The names of several data items could be improved to better match the overall naming style of the dictionaries. Proposals:

  • Rename _topol_link.voronoi_solidangle to _topol_link.Voronoi_solid_angle. This would clearly split "solidangle" into two words and capitalise the Voronoi surname. Note, that the latter change would also require slight modification of the GitHub action checker.
  • Rename _topol_tiling.Dsize to _topol_tiling.D-size (or _topol_tiling.D_size). Adding an extra symbol between "D" and "size" makes it slightly more readable and is closer to the way the term (D-size) is defined in the paper that the data item definition is based on [1]. The dash, although uncommon in data names, has been previously used (e.g. _space_group.name_H-M_alt).

Are these changes acceptable?

[1] https://www.doi.org/10.1039/B910671E

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/COMCIFS/TopoCif/issues/47, or unsubscribe https://github.com/notifications/unsubscribe-auth/AEHNCW72KD6LOYELSH57O6DUB2H7XANCNFSM5D66HMWA . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

-- Robert M. Hanson Professor of Chemistry St. Olaf College Northfield, MN http://www.stolaf.edu/people/hansonr

If nature does not answer first what we want, it is better to take what answer we get.

-- Josiah Willard Gibbs, Lecture XXX, Monday, February 5, 1900

We stand on the homelands of the Wahpekute Band of the Dakota Nation. We honor with gratitude the people who have stewarded the land throughout the generations and their ongoing contributions to this region. We acknowledge the ongoing injustices that we have committed against the Dakota Nation, and we wish to interrupt this legacy, beginning with acts of healing and honest storytelling about this place.

jcbollinger commented 3 years ago

I do not object, but I do observe that

vaitkus commented 3 years ago

@jcbollinger Thank you for stressing these points.

In this case the original English spelling of the term (D-size) also uses the dash so writing it as Dsize looks a bit off to me. Would you prefer D_size or even the unchanged Dsize?

dmproserpio commented 3 years ago 
D-Size is perfect, thanks

Davide

Antanas Vaitkus ha scritto il
  14/09/2021 alle 15:33:

  @jcbollinger
    Thank you for stressing these points.
  In this case the original English spelling of the term (D-size)
    also uses the dash so writing it as Dsize looks a
    bit off to me. Would you prefer D_size or even the
    unchanged Dsize?
  —
    You are receiving this because you are subscribed to this
    thread.
    Reply to this email directly, view it on GitHub, or unsubscribe.
    Triage notifications on the go with GitHub Mobile for iOS or Android.

  [

{ @.": "http://schema.org", @.": "EmailMessage", "potentialAction": { @.": "ViewAction", "target": "https://github.com/COMCIFS/TopoCif/issues/47#issuecomment-919156189", "url": "https://github.com/COMCIFS/TopoCif/issues/47#issuecomment-919156189", "name": "View Issue" }, "description": "View this Issue on GitHub", "publisher": { @.": "Organization", "name": "GitHub", "url": "https://github.com" } } ]

--

Prof. Davide M. Proserpio
Universita' degli Studi di Milano, Dipartimento di Chimica
Via Golgi, 19 - 20133 Milano, Italy Skype: dmproserpio
ph. +39-0250314446 @.***

Samara Center for Theoretical Materials Science (SCTMS) Samara State Technical University, Molodogvardeyskaya St. 244, Samara 443100, Russia http://english.sctms.ru/about/

List of publication at http://www.researcherid.com/rid/C-6391-2009 or http://scholar.google.com/citations?user=7jye64cAAAAJ

TRY TOPOS at http://www.topospro.com http://pubs.acs.org/doi/pdf/10.1021/cg500498k

Il tuo 5xmille all'Università degli Studi di Milano Il valore della ricerca interdisciplinare Codice fiscale: 80012650158

vaitkus commented 3 years ago

I also received a reply from Vlad in a separate discussion thread that is not visible on GitHub:

...

I think the best choice is "_" as delimiter, i.e.

'_topol_link.Voronoi_solid_angle
'_topol_tiling.D_size

...

Based on this and on a previous comment by @jcbollinger , _topol_tiling.D_size seems like the way to go. Hopefully, @dmproserpio is also OK with this.

vaitkus commented 3 years ago

Resolved by merging PR #51.