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.

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

Fix rst indentation and internal references #491

Merged

Conversation

vaitkus
Copy link
Contributor

@vaitkus vaitkus commented Jan 12, 2024

This PR fixes a few formatting issues that cause warnings when converting the rst file to a pdf using pandoc. Not sure how and if these issues manifested on GitHub since currently I cannot force this file to render here (earlier version of this file also do not render).

Also, the elements_ratios field was misspelt as element_ratios in several places that deal with the metadata properties.

Finally, is there a simple way to make a field name to both link to the corresponding section in the document and be formatted in the same way as other fields (i.e. to combine ":field:elements_ratios" and "elements_rations_")?

@ml-evs
Copy link
Member

ml-evs commented Jan 12, 2024

Thanks for this @vaitkus, fixes look good (will review properly soon). We should add the pandoc converted spec to the CI at some point (see #378 and #482)

Just wanted to raise the issue that I don't seem to be able to preview RST anymore on GitHub... at all... does anyone else have this issue? Even older versions of the spec are not renderable...

Copy link
Contributor

@rartino rartino left a comment

Choose a reason for hiding this comment

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

The corrections all seem correct to me.

Copy link
Member

@ml-evs ml-evs left a comment

Choose a reason for hiding this comment

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

Likewise, thanks for spotting these @vaitkus.

@vaitkus
Copy link
Contributor Author

vaitkus commented Jan 12, 2024

@ml-evs Is it OK to merge this now or would it be better to wait until the RST rendering issue is resolved?

@ml-evs
Copy link
Member

ml-evs commented Jan 12, 2024

I'll merge now, I think these are clear specification bugs and we can imagine what the rendered docs will look like. Not sure if the resolution will come anytime soon...

@ml-evs ml-evs merged commit 8f7c02c into Materials-Consortia:develop Jan 12, 2024
5 checks passed
@vaitkus vaitkus deleted the fix-internal-rst-references branch January 15, 2024 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants