search

chaoss / grimoirelab-elk

GNU General Public License v3.0
58 stars 121 forks source link

Misleading description of the `body` field in some schemas #1017

Open canasdiaz opened 2 years ago

canasdiaz commented 2 years ago

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 commented 2 years ago

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.