-
Notifications
You must be signed in to change notification settings - Fork 30
docs: update the Output Files Guide page in the Sphinx documentation #281
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
docs: update the Output Files Guide page in the Sphinx documentation #281
Conversation
Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
docs/source/pages/output_files.rst
Outdated
| Unique result path | ||
| '''''''''''''''''' | ||
|
|
||
| Macaron creates a different directory under ``reports`` to store the report files for each target repository. This directory |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressed in cacf960
docs/source/pages/output_files.rst
Outdated
| .. 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressed in cacf960
docs/source/pages/output_files.rst
Outdated
| Report types | ||
| '''''''''''' | ||
|
|
||
| There are currently three types of report that Macaron creates: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| There are currently three types of report that Macaron creates: | |
| Macaron creates three types of reports: |
There was a problem hiding this comment.
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>
…281) Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
Closes #278