Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace filter/property example 'bandgap' with 'band_gap' for clarity #358

Merged
merged 5 commits into from
May 25, 2021
Merged

Replace filter/property example 'bandgap' with 'band_gap' for clarity #358

merged 5 commits into from
May 25, 2021

Conversation

ml-evs
Copy link
Member

@ml-evs ml-evs commented Apr 27, 2021 •
edited
Loading

Closes #357 following a comment from a reviewer of the OPTIMADE paper. Although both spellings are valid examples, for the sake of clarity we should unify them.

Also fixes the formatting of the examples of database-specific property names and of the query examples for elements.

@ml-evs ml-evs marked this pull request as ready for review April 27, 2021 11:01
merkys
merkys previously approved these changes Apr 27, 2021
View reviewed changes
Copy link
Member

@merkys merkys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! To me band_gap also looks better than bandgap.

@ml-evs
Copy link
Member Author

ml-evs commented Apr 27, 2021

Looks good! To me band_gap also looks better than bandgap.

The Wikipedia article "Band gap" uses "band gap" 56 times and "bandgap" 18 times within itself 🙃

@ml-evs ml-evs requested a review from gmrigna May 19, 2021 16:19
@ml-evs ml-evs requested a review from merkys May 21, 2021 14:52
@ml-evs
Copy link
Member Author

ml-evs commented May 21, 2021 •
edited
Loading

Just added another formatting fix I spotted, where a missing newline was causing problems in rendering bulletpoints.

The main fix in this PR bandgap->band_gap should really be merged before we resubmit the paper, as we explicitly say we have done it in our reviewer response.

@merkys @gmrigna @rartino would two of you be able to okay this?

I have also just added a note that links elements and nelements, matching the format we use for dimension_types and nperiodic_dimensions.

merkys
merkys approved these changes May 24, 2021
View reviewed changes
Copy link
Member

@merkys merkys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@ml-evs ml-evs requested a review from ctoher May 25, 2021 16:24
ctoher
ctoher approved these changes May 25, 2021
View reviewed changes
Copy link
Contributor

@ctoher ctoher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for fixing.

@ml-evs ml-evs merged commit b94a95b into develop May 25, 2021
@ml-evs ml-evs deleted the ml-evs/bandgap_fix branch May 25, 2021 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ctoher ctoher ctoher approved these changes

@gmrigna gmrigna gmrigna approved these changes

@merkys merkys merkys approved these changes

@CasperWA CasperWA Awaiting requested review from CasperWA

@rartino rartino Awaiting requested review from rartino

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Clarify _exmpl_band_gap vs _exmpl_bandgap lexical examples
4 participants
@ml-evs @ctoher @gmrigna @merkys