feat(sdk): improve docs + code clarity

[hsheth2]

Adds some docs across our core interfaces and refactors some code.

Checklist

• The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
• Links to related issues (if applicable)
• Tests for the changes have been added/updated (if applicable)
• Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
• For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

[codecov]

Codecov Report

Attention: Patch coverage is 85.71429% with 1 line in your changes missing coverage. Please review.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
...-ingestion/src/datahub/utilities/urns/_urn_base.py	80.00%	1 Missing ⚠️

Files with missing lines	Coverage Δ
...data-ingestion/src/datahub/emitter/enum_helpers.py	100.00% <100.00%> (ø)
...adata-ingestion/src/datahub/emitter/mce_builder.py	81.77% <ø> (ø)
...-ingestion/src/datahub/ingestion/api/decorators.py	98.18% <ø> (ø)
...tadata-ingestion/src/datahub/ingestion/api/sink.py	97.33% <ø> (ø)
...data-ingestion/src/datahub/ingestion/api/source.py	99.15% <ø> (ø)
...-ingestion/src/datahub/utilities/urns/_urn_base.py	85.11% <80.00%> (-0.34%)	⬇️

... and 3 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b4e23c5...f0cbecf. Read the comment docs.

[sgomezvillamor]

this is not a concern anymore because of the added abc.update_abstractmethods(cls) ?

[hsheth2]

yup that's the idea. but abc.update_abstractmethods was only added in python 3.10, so I might need to revert this