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

Documented what materials can't be parsed #570

Merged
merged 4 commits into from
Oct 15, 2024
Merged

Documented what materials can't be parsed #570

merged 4 commits into from
Oct 15, 2024

Conversation

MicahGale
Copy link
Collaborator

Description

Wrote up what materials can't be parsed in the README. Also added a new section in the user guide for issues like this.

Fixes #542.

Checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation (if applicable)

@MicahGale MicahGale added the documentation Improvements or additions to documentation label Oct 15, 2024
@MicahGale MicahGale requested a review from tjlaboss October 15, 2024 21:14
@MicahGale MicahGale self-assigned this Oct 15, 2024
tjlaboss
tjlaboss approved these changes Oct 15, 2024
View reviewed changes
Copy link
Collaborator

@tjlaboss tjlaboss left a comment

Choose a reason for hiding this comment

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

Test failure OK: Spurious changelog-test failure because a docstring was modified.

@MicahGale
Copy link
Collaborator Author

Thanks for the review.

@MicahGale MicahGale merged commit c5b84e6 into develop Oct 15, 2024
19 of 20 checks passed
@MicahGale MicahGale deleted the mat_limit branch October 15, 2024 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tjlaboss tjlaboss tjlaboss approved these changes

Assignees

@MicahGale MicahGale

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document limitation to what materials can be parsed
2 participants
@MicahGale @tjlaboss