little clarification for docs

[denis-yuen]

Description
Add a little bit of documentation during review

Review Instructions
n/a

Issue
https://ucsc-cgl.atlassian.net/browse/SEAB-5953

Security
None

• Check that you pass the basic style checks and unit tests by running mvn clean install in the project that you have modified (until https://ucsc-cgl.atlassian.net/browse/SEAB-5300 adds multi-module support properly)
• Ensure that the PR targets the correct branch. Check the milestone or fix version of the ticket.
• If you are changing dependencies, check with dependabot to ensure you are not introducing new high/critical vulnerabilities
• If this PR is for a user-facing feature, create and link a documentation ticket for this feature (usually in the same milestone as the linked issue). Style points if you create a documentation PR directly and link that instead.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 45.70%. Comparing base (0381ffd) to head (62d3864).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@            Coverage Diff             @@
##             develop     #502   +/-   ##
==========================================
  Coverage      45.70%   45.70%           
  Complexity       319      319           
==========================================
  Files             50       50           
  Lines           2700     2700           
  Branches         210      210           
==========================================
  Hits            1234     1234           
  Misses          1375     1375           
  Partials          91       91           

Flag	Coverage Δ
metricsaggregator	36.70% <ø> (ø)
toolbackup	22.85% <ø> (ø)
tooltester	17.07% <ø> (ø)
topicgenerator	20.29% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.