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

Documentation Typos #554

Closed
dylan-asmar opened this issue Jun 21, 2024 · 5 comments
Closed

Documentation Typos #554

dylan-asmar opened this issue Jun 21, 2024 · 5 comments
Labels
documentation quick This task shouldn't take too long

Comments

@dylan-asmar
Copy link
Member

@dylan-asmar dylan-asmar added documentation quick This task shouldn't take too long labels Jun 21, 2024
@MaderDash
Copy link
Contributor

Please let me know if you still need assistance with this. and if you do then point to what file the errors are found in. @dylan-asmar

@dylan-asmar
Copy link
Member Author

dylan-asmar commented Jul 4, 2024

I welcome the help! The changes should be pretty straightforward with the only non-typo error being the @show_requirements one.

For each of the pages, there is an associated markdown file in POMPDs.jll/docs/src. For example, the first set of typos is in example_defining_problems.md.

@MaderDash
Copy link
Contributor

I believe I understand. I'll try to make corrections tomorrow, if that's alright. I'll create a "typo" branch to simplify the merging process for you, or to work with in case there are any issues. Then, I'll submit a pull request to merge it back into your main branch.

@dylan-asmar
Copy link
Member Author

That sounds great!

@MaderDash MaderDash mentioned this issue Jul 5, 2024
@dylan-asmar
Copy link
Member Author

Fixed with #557

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation quick This task shouldn't take too long
Projects
None yet
Development

No branches or pull requests

2 participants