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

Add UML designs to developer documentation. #143

Merged
merged 4 commits into from
Nov 21, 2024

Conversation

MatthewHambley
Copy link
Collaborator

No description provided.

@MatthewHambley MatthewHambley requested review from a team, allynt and mo-lucy-gordon and removed request for a team and allynt October 17, 2024 08:24
Copy link

@allynt allynt left a comment

Choose a reason for hiding this comment

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

This code looks fine. The diagrams look nice as well. But there is now an extra dependency on plantuml. This ought to be noted in the installation instructions; I had to add:

plantuml = 'java -jar /path/to/plantuml-jar-file'

in "documentation/source/conf.py" in order to get it to build.

Copy link

@allynt allynt left a comment

Choose a reason for hiding this comment

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

Additionally, when I build it locally some of the diagrams are cut off. I assume that is not your intention.

Capture

@MatthewHambley MatthewHambley marked this pull request as ready for review November 15, 2024 11:50
Copy link

@allynt allynt left a comment

Choose a reason for hiding this comment

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

Looks good to me. The ability to add UML Diagrams is a useful addition. Both of my concerns were addressed by the latest commits.

@MatthewHambley MatthewHambley merged commit e97c18c into MetOffice:master Nov 21, 2024
6 checks passed
@MatthewHambley MatthewHambley deleted the DeveloperUML branch November 21, 2024 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants