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 field access in ytdata docs. #4388

Merged
merged 1 commit into from
Mar 28, 2023
Merged

Conversation

brittonsmith
Copy link
Member

PR Summary

I stumbled across an error in the render of the docs. This should fix it.

PR Checklist

  • New features are documented, with docstrings and narrative docs
  • Adds a test for any bugs fixed. Adds tests for new features.

Copy link
Member

@neutrinoceros neutrinoceros left a comment

Choose a reason for hiding this comment

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

While we're at it, might as well align the style with the rest of the docs.
I'll check the docs build when it completes !

Comment on lines +230 to +231
print (array_ds.data["data", "region_density"])
print (array_ds.data["data", "sphere_density"])
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
print (array_ds.data["data", "region_density"])
print (array_ds.data["data", "sphere_density"])
print(array_ds.data["data", "region_density"])
print(array_ds.data["data", "sphere_density"])

@@ -245,4 +245,4 @@ dictionary.
yt.save_as_dataset(fake_ds, "random_data.h5", my_data)

new_ds = yt.load("random_data.h5")
print (new_ds.data["gas", "density"])
print (new_ds.data["data", "density"])
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
print (new_ds.data["data", "density"])
print(new_ds.data["data", "density"])

@neutrinoceros
Copy link
Member

my comments are not critical, and I can confirm the fix, so let's get in. Thanks Britton !

@neutrinoceros neutrinoceros merged commit 4edd0f8 into yt-project:main Mar 28, 2023
@brittonsmith
Copy link
Member Author

Ah, sorry, I had checked out for the day. Feel free to apply that sort of thing to my PRs in the future. Thanks!

@brittonsmith brittonsmith deleted the docfix branch March 29, 2023 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants