docs: Add clarifications for mergeable field in pull requests

[acouvreur]

Comparing the OpenAPI spec for pull requests shows that these fields are not populated when listing (right), but they are through GET or webhook:

In their OpenAPI Spec they have pull-request and pull-request-simple definitions.

I think that would make sense to also have these structs instead of relying on comments for contextual field population.

[acouvreur]

It is now one single block comment @gmlewis

[gmlewis]

Please run the scripts listed in step 4 of CONTRIBUTING.md and push the changes. That should fix the linter and tests.

[gmlewis]

I will close this PR around the end of January, 2025 as "abandoned" if there is no further response.

[acouvreur]

I will close this PR around the end of January, 2025 as "abandoned" if there is no further response.

Done just in time :)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.03%. Comparing base (7783310) to head (dd2c798).
Report is 1 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #3396 +/- ##
=======================================
Coverage 91.03% 91.03% =======================================
Files 179 179 Lines 15535 15535 =======================================
Hits 14142 14142 Misses 1221 1221 Partials 172 172 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[gmlewis]

Thank you, @acouvreur !
LGTM.
Merging.