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

Issue 46: Function use flowchart #54

Merged
merged 4 commits into from
Jun 17, 2024
Merged

Issue 46: Function use flowchart #54

merged 4 commits into from
Jun 17, 2024

Conversation

athowes
Copy link
Collaborator

@athowes athowes commented May 23, 2024

Description

Status: work in progress! As the parts of the package get clearer this is making more sense to me.

This PR closes #46. (It could be incorrect that I am writing and commiting code to close this.)

So far I have done the static analysis. I was also going to create the mermaid document and store it as a .md file or something like that in inst/. Any better ideas about what to do with it? It seems nice in some way to have this type of design document be version controlled but maybe it's better in discussions or somewhere like that.

Checklist

  • My PR is based on a package issue and I have explicitly linked it.
  • I have included the target issue or issues in the PR title in the for Issue(s) issue-numbers: PR title
  • I have read the contribution guidelines.
  • I have tested my changes locally.
  • I have added or updated unit tests where necessary.
  • I have updated the documentation if required.
  • My code follows the established coding standards.
  • I have added a news item linked to this PR.
  • I have reviewed CI checks for this PR and addressed them as far as I am able.

@seabbs
Copy link
Contributor

seabbs commented May 24, 2024

I have quite liked it (the mermaid) being in the main docs as it is in EpiAware and have usually put the script that creates the static analysis in inst vs the actual diagram but no strong view on that one

@athowes athowes self-assigned this May 30, 2024
@athowes athowes added the soft block PRs that are softly blocked label Jun 12, 2024
@athowes
Copy link
Collaborator Author

athowes commented Jun 17, 2024

To get this closed, I suggest that we keep the code to produce the static analysis, and move the mermaid chart to another issue.

Edit: new issue is here #109.

@athowes athowes force-pushed the function-flowchart branch from e3dd8bb to ebfe198 Compare June 17, 2024 09:57
@athowes athowes requested a review from seabbs June 17, 2024 09:58
@athowes athowes marked this pull request as ready for review June 17, 2024 10:12
@seabbs seabbs added this pull request to the merge queue Jun 17, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 17, 2024
@athowes athowes added this pull request to the merge queue Jun 17, 2024
Merged via the queue into main with commit aadbc89 Jun 17, 2024
9 checks passed
@athowes athowes deleted the function-flowchart branch June 17, 2024 13:08
seabbs pushed a commit that referenced this pull request Jan 10, 2025
* Functional dependences static analysis

* Test copying over EpiAware function diagram

* Delete README

* Rename to static_code_analysis and delete saved .png

Former-commit-id: 3d1873e424dc548810c4ad0947270cf1143ee1bb [formerly fb3d4353d0d77edaeef347f0b1a6284791ebec15]
Former-commit-id: 2f1a52a2a59648294c053be9bafab7c0ba5c124b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
soft block PRs that are softly blocked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create function use flowchart
2 participants