feat: added mermaid diagrams for some functions in ManifestGenerator

[linglp]

feature

Added some mermaid diagrams for the following schematic functions:

• _handle_output_format_logic
• create_manifests
• get_manifests

The diagrams were auto-generated by mermaid chatgpt plug-in, and will appear on Pdoc for schematic documentation!

Test out the documentation

To preview:

podc --mermaid path/to/manifest/generator.py

[linglp]

Below is a diagram generated for get_manifest function. Here's the preview:

flowchart TD
    A[Start] --> B{Dataset ID provided?}
    B -- No --> C[Get Empty Manifest URL]
    C --> D{Output Format is 'excel'?}
    D -- Yes --> E[Export to Excel]
    D -- No --> F[Return Manifest URL]
    B -- Yes --> G[Instantiate SynapseStorage]
    G --> H[Update Dataset Manifest Files]
    H --> I[Get Empty Manifest URL]
    I --> J{Manifest Record exists?}
    J -- Yes --> K[Update Dataframe]
    K --> L[Handle Output Format Logic]
    L --> M[Return Result]
    J -- No --> AN{Use Annotations?}

    AN -- No --> Q[Create dataframe from empty manifest on Google]
    Q --> AJ{Manifest file-based?}
    AJ -- Yes --> P[Add entityId and filename to manifest df]
    AJ -- No --> R[Use dataframe from an empty manifest]

    P --> L[Handle Output Format Logic]
    R -->  L[Handle Output Format Logic]

    AN -- Yes --> AM{Manifest file-based?}
    AM -- No --> L[Handle Output Format Logic]
    AM -- Yes --> AO[Process Annotations]
    AO --> AP{Annotations Empty?}
    AP -- Yes --> AQ[Create dataframe from an empty manifest on Google]
    AQ --> AR[Update dataframe]
    AP -- No --> AS[Get Manifest with Annotations]
    AS --> AR
    AR --> L[Handle Output Format Logic]
    M --> T[End]
    F --> T
    E --> T

Loading

[thomasyu888]

@linglp This is fantastic! I think if you resolve conflicts, let's get this merged in!

Not urgent ofcourse.

[BryanFauble]

A few comments, otherwise LGTM!

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[MiekoHash]

@linglp Which JIRA ticket is this for? cc: @andrewelamb