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.

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

Misleading description of the body field in some schemas #1017

Open
canasdiaz opened this issue Dec 15, 2021 · 1 comment
Open

Misleading description of the body field in some schemas #1017

canasdiaz opened this issue Dec 15, 2021 · 1 comment
Labels
documentation good first issue Good issue for first-time contributors

Comments

@canasdiaz
Copy link
Contributor

Having a look at the schemas offered for github_issues.csv and github2_pull_requests.csv I find misleading the description of the field body which is Body of the issue/comment.

The description would be more clear with something like Body of the comment. It would be nice to look for the same "error" in other schemas and to fix it.

@vchrombie vchrombie added the good first issue Good issue for first-time contributors label Jan 30, 2022
@vchrombie
Copy link
Member

Thanks for opening the issue @sanacl

Having a look at the schemas offered for github_issues.csv and github2_pull_requests.csv I find misleading the description of the field body which is Body of the issue/comment.

From what I inferred, the description Body of the issue/comment. could be read as "body of the issue or comment". Is this what you would like to point out?

From what I remember, github2 is mainly for comments, but I think it enriches the issue items too but not just the comments. Well, I have to check and re-confirm it tho. In that case, I think the current description fits well. WDYT?

The description would be more clear with something like Body of the comment. It would be nice to look for the same "error" in other schemas and to fix it.

If the data has both issues data and issue comments data, then the current description looks fine. But if it only produces the comments data, I think it is better to replace it with Body of the issue comment. or Body of the pull request comment.

Please let me know your views.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue Good issue for first-time contributors
Projects
None yet
Development

No branches or pull requests

2 participants