Skip to content

Conversation

@tromai
Copy link
Contributor

@tromai tromai commented Jun 4, 2023

Closes #278

Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
@tromai tromai added this to the Release v0.1.0 milestone Jun 4, 2023
@tromai tromai requested a review from behnazh-w as a code owner June 4, 2023 02:57
@tromai tromai self-assigned this Jun 4, 2023
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Jun 4, 2023
Unique result path
''''''''''''''''''

Macaron creates a different directory under ``reports`` to store the report files for each target repository. This directory
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Macaron creates a different directory under ``reports`` to store the report files for each target repository. This directory
For each target repository, Macaron creates a directory under ``reports`` to store the report files. This directory

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed in cacf960

.. note:: The git host name has all occurrence of ``.`` in the URL replaced by ``_``.

For example, when analyze the repository at `<https://github.com/micronaut-projects/micronaut-core>`_, Macaron will store
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
For example, when analyze the repository at `<https://github.com/micronaut-projects/micronaut-core>`_, Macaron will store
For example, the reports for `<https://github.com/micronaut-projects/micronaut-core>`_ repository will be stored under

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed in cacf960

Report types
''''''''''''

There are currently three types of report that Macaron creates:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
There are currently three types of report that Macaron creates:
Macaron creates three types of reports:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed in cacf960

Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
@tromai tromai merged commit f3f9ecf into staging Jun 5, 2023
@tromai tromai deleted the 278-update-the-content-of-the-output-files-guide-page-in-our-sphinx-documentation branch June 5, 2023 05:15
art1f1c3R pushed a commit that referenced this pull request Nov 29, 2024
…281)

Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

OCA Verified All contributors have signed the Oracle Contributor Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update the content of the Output Files Guide page in our Sphinx documentation

2 participants