Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix serialization related property name problems #8941

Merged
merged 1 commit into from
Jul 6, 2023

Conversation

filzrev
Copy link
Contributor

@filzrev filzrev commented Jul 6, 2023

This PR contains following changes.

1.OriginalHomepage changes(88104f6)

JSON/YAML Alias names use wrong spelling names. (OriginallHomepage)
There is compatibility problems. If these name are changed.

But this property is added recently (about 4 month ago) and option is undocumented. (#7736 (comment))

So there is almost no impact by changing these name settings.

2. EnableSourceInfo changes(88104f6)

Change JSON property name to enableSourceInfo.
It seems there is no compatibility problems by this changes.

@filzrev filzrev changed the title Fix serialization relating property name attributes Fix serialization related property name problems Jul 6, 2023
@codecov
Copy link

codecov bot commented Jul 6, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.01 ⚠️

Comparison is base (c1545fe) 76.90% compared to head (88104f6) 76.90%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8941      +/-   ##
==========================================
- Coverage   76.90%   76.90%   -0.01%     
==========================================
  Files         605      605              
  Lines       25088    25088              
==========================================
- Hits        19295    19294       -1     
- Misses       5793     5794       +1     
Impacted Files Coverage Δ
...DocAsCode.DataContracts.Common/TocItemViewModel.cs 71.73% <ø> (ø)
...oft.DocAsCode.Plugins/MarkdownServiceParameters.cs 100.00% <ø> (ø)

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@yufeih yufeih left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@yufeih yufeih merged commit 71e1479 into dotnet:main Jul 6, 2023
@KalleOlaviNiemitalo
Copy link

KalleOlaviNiemitalo commented Jul 6, 2023

But this property is added recently (about 4 month ago)

The TocItemViewModel.OriginalHomepage property and the misspelling originallHomepage are far older; the attributes [YamlMember(Alias = "originallHomepage")] [JsonProperty("originallHomepage")] were added in #2082, September 2017. But I think this property is intended for DocFX internal serialization only; not for use in YAML metadata, in custom templates, or in external equivalents of docfx metadata for other programming languages.

@filzrev filzrev deleted the fix-serialization-relating-spellings branch July 17, 2023 00:18
@yufeih yufeih added the bug-fix Makes the pull request to appear in "Bug Fixes" section of the next release note label Jul 24, 2023
p-kostov pushed a commit to ErpNetDocs/docfx that referenced this pull request Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug-fix Makes the pull request to appear in "Bug Fixes" section of the next release note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants