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

11 update puml documentation #18

Merged
merged 16 commits into from
Apr 30, 2024
Merged

Conversation

lizzcondrey
Copy link
Contributor

@lizzcondrey lizzcondrey commented Apr 26, 2024

Description

Adding documentation for the plugin and the four commands contained within.

Linked Items:

Closes/Fixes/Resolves #11

Added

  • Documentation for plugin
  • documentation for component command
  • documentation for object command
  • documentation for requirements command
  • documentation for sequence command

Checklist:

  • I updated project documentation to reflect my changes.
  • My changes generate no new warnings.
  • I updated new and existing unit tests to account for my changes.
  • I linked the associated item(s) to be closed.
  • I bumped the version.
  • I added the labels corresponding to my changes.

@lizzcondrey lizzcondrey added documentation Improvements or additions to documentation added For when PR includes information in the added category labels Apr 26, 2024
@lizzcondrey lizzcondrey added this to the 24.1.5 milestone Apr 26, 2024
@lizzcondrey lizzcondrey requested a review from bunchw April 26, 2024 15:03
@lizzcondrey lizzcondrey linked an issue Apr 26, 2024 that may be closed by this pull request
8 tasks
@lizzcondrey
Copy link
Contributor Author

Going to have to dig in to what is going on with the setup python action, but out of hours to do so today. I'll work at it Monday.

…tup-python action due to a recent breaking PR for the action
…s-14 for now, need to wait on rebuild and deploy for 3.9.13 support to be fully back it seems
@lizzcondrey
Copy link
Contributor Author

actions/setup-python#853

So, this was the fix for addressing the failures we were having with pipeline builds, not anything we could have really done on our end to fix it until they had adjusted their builds and packaging provided by the action. It has now been corrected and proper handling for the MacOS transition was provided.

@bunchw this is now truly ready for review.

@lizzcondrey lizzcondrey merged commit 76f4f32 into main Apr 30, 2024
15 of 16 checks passed
@lizzcondrey lizzcondrey deleted the 11-update-puml-documentation branch April 30, 2024 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
added For when PR includes information in the added category documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✏️📘 [PUML Documentation] - Update PUML Documentation
2 participants