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.

Sign up for GitHub

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

Jump to bottom

Add "how to read the reports" section #960

Closed
JustinWonjaePark opened this issue May 7, 2021 · 0 comments · Fixed by #966
Closed

Add "how to read the reports" section #960

JustinWonjaePark opened this issue May 7, 2021 · 0 comments · Fixed by #966
Assignees
@rnjudge
Labels
docs Documentation changes

Comments

@JustinWonjaePark
Copy link

Problem Statement
Reports of tern provides a lot of information, and the types and format of the items provided varies depending on the report format. Thus, users might not understand what kind information they can get from the reports and where to look at to get the information on the report.

Describe the Proposal
Adding "how to read the reports" section on README.md can help the users to know what they can expect at the reports.

Steps to Implement Proposal
N/A
@rnjudge rnjudge added the docs Documentation changes label May 7, 2021
@rnjudge rnjudge self-assigned this May 12, 2021
rnjudge added a commit to rnjudge/tern that referenced this issue May 12, 2021
@rnjudge
Add 'Understanding the Reports' section to README
cb1b822 
Reports of tern provides a lot of information, and the types and format
of the items provided varies depending on the report format. Thus,
users might not understand what kind information they can get from
the reports and where to look at to get the information on the report.
This commit adds information about the specific type of information
available in each report format to the README.

Resolves tern-tools#960

Signed-off-by: Rose Judge <rjudge@vmware.com>
rnjudge added a commit to rnjudge/tern that referenced this issue May 12, 2021
@rnjudge
Add 'Understanding the Reports' section to README
9f98e7f 
Reports of tern provides a lot of information, and the types and format
of the items provided varies depending on the report format. Thus,
users might not understand what kind information they can get from
the reports and where to look at to get the information on the report.
This commit adds information about the specific type of information
available in each report format to the README.

Resolves tern-tools#960

Signed-off-by: Rose Judge <rjudge@vmware.com>
@rnjudge rnjudge mentioned this issue May 12, 2021
Merged
rnjudge added a commit that referenced this issue May 18, 2021
@rnjudge
Add 'Understanding the Reports' section to README
63def2d 
Reports of tern provides a lot of information, and the types and format
of the items provided varies depending on the report format. Thus,
users might not understand what kind information they can get from
the reports and where to look at to get the information on the report.
This commit adds information about the specific type of information
available in each report format to the README.

Resolves #960

Signed-off-by: Rose Judge <rjudge@vmware.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rnjudge rnjudge

Labels
docs Documentation changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add 'Understanding the Reports' section to README rnjudge/tern
2 participants
@rnjudge @JustinWonjaePark