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

Update documentation #62

Merged
merged 14 commits into from
Jan 8, 2025
Merged

Update documentation #62

merged 14 commits into from
Jan 8, 2025

Conversation

brryan
Copy link
Collaborator

@brryan brryan commented Jan 7, 2025 •
edited
Loading

Some documentation issues to be improved:

  • Actual LaTeX formatting for equations in README
  • Function signatures for callable quantities
  • Distinguish between frequency-averaged and multifrequency opacity variants
  • Describe units modifier usage

Yurlungur
Yurlungur approved these changes Jan 8, 2025
View reviewed changes
Copy link
Collaborator

@Yurlungur Yurlungur left a comment

Choose a reason for hiding this comment

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

Thanks for the fix!

@Yurlungur
Copy link
Collaborator

Go ahead and merge when you're ready

@brryan
Copy link
Collaborator Author

brryan commented Jan 8, 2025

Unfortunately github markdown does not support whitespace in math equations so the units are squished together.

@brryan brryan merged commit d93837f into main Jan 8, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Yurlungur Yurlungur Yurlungur approved these changes

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

Successfully merging this pull request may close these issues.
2 participants
@brryan @Yurlungur