GitHub.raw_search should return total_count parameter in the generator
Search API also provides a parameter total_count(see) explicitly. It would be good to also return that parameter into the generator.
Why we need this?
- Suppose that I did the following search:
search_query = 'commenter:sks444 is:pr user:coala'
results = GitHub.raw_search(token, search_query)
It returns a generator of objects of all the matched merge requests. Now, what if I just need the total number of results? Probably I have to do (sum(1 for _ in result), that would be a performance problem with the increase in the number of results.
- As mentioned here, search API only provides max of 1000 results. But in case of
search_query = 'commenter:jayvdb is:pr user:coala'total_count is 1720(more than 1000) see https://api.github.com/search/issues?q=commenter:jayvdb%20is:pr%20user:coala
So, returning the total_count parameter would also help in case of more 1000 results.