Update comments in _make_dataclass_serializable

[mao3267]

Tracking issue

Closes flyteorg/flyte#5905

Why are the changes needed?

Since all Flyte types are now serializable, the current usage of the _make_dataclass_serializable function is unclear and may seem to be no longer necessary. Therefore, we have requested an update to the comments in this function to clarify its purpose.

What changes were proposed in this pull request?

1. Update the comments under the function _make_dataclass_serializable
2. Provide example usage on Flyte files and its lifecycle

How was this patch tested?

None

Setup process

gh pr checkout 2856

Screenshots

None

Check all the applicable boxes

• I updated the documentation accordingly.
• All new and existing tests passed.
• All commits are signed-off.

Related PRs

None

Docs link

None

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.41%. Comparing base (3fc51af) to head (f9b9cba).
Report is 2 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff             @@
##           master    #2856       +/-   ##
===========================================
+ Coverage   45.53%   79.41%   +33.87%     
===========================================
  Files         196      196               
  Lines       20418    20471       +53     
  Branches     2647     2650        +3     
===========================================
+ Hits         9298    16257     +6959     
+ Misses      10658     3477     -7181     
- Partials      462      737      +275     

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