Skip to content

docs: fix typos, deprecation notes, dead links, and formatting cleanup#10856

Merged
andrewconnell merged 7 commits into
SharePoint:mainfrom
Ashlesha-MSFT:fix/doc-updates-cleanup2
Jun 1, 2026
Merged

docs: fix typos, deprecation notes, dead links, and formatting cleanup#10856
andrewconnell merged 7 commits into
SharePoint:mainfrom
Ashlesha-MSFT:fix/doc-updates-cleanup2

Conversation

@Ashlesha-MSFT
Copy link
Copy Markdown
Contributor

Category

  • Content fix

Related issues

What's in this Pull Request?

docs: fix typos, deprecation notes, dead links, and formatting cleanup

  • Add deprecation/applicability notes to Excel Web Services and claims provider docs
  • Fix VB.net code bugs (wrong enum, C# syntax in VB comments)
  • Update MSDN links to learn.microsoft.com and relative /previous-versions/ paths
  • Update http:// to https:// in workbook path examples
  • Remove redundant anchors and whitespace-only lines
  • Fix typos: missing spaces, <./param>, wrong method name
  • Update Visual Studio 2012 and .NET 3.5 references to current versions in OData doc

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit d3b1fe5:

💡 Validation status: suggestions

File Status Preview URL Details
docs/general-development/how-to-get-values-from-ranges.md 💡Suggestion View Details
docs/general-development/how-to-set-values-of-ranges.md 💡Suggestion View Details
docs/general-development/how-to-create-an-odata-data-service-for-use-as-a-bcs-external-system.md ✅Succeeded View
docs/general-development/how-to-deploy-a-claims-provider-in-sharepoint.md ✅Succeeded View
docs/general-development/how-to-get-an-entire-workbook-or-a-snapshot.md ✅Succeeded View

docs/general-development/how-to-get-values-from-ranges.md

  • Line 41, Column 754: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/arrays#jagged-arrays' will be broken in isolated environments. Replace with a relative link.

docs/general-development/how-to-set-values-of-ranges.md

  • Line 41, Column 745: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/arrays#jagged-arrays' will be broken in isolated environments. Replace with a relative link.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 359b6c0:

💡 Validation status: suggestions

File Status Preview URL Details
docs/general-development/how-to-set-values-of-ranges.md 💡Suggestion View Details
docs/general-development/how-to-create-an-odata-data-service-for-use-as-a-bcs-external-system.md ✅Succeeded View
docs/general-development/how-to-deploy-a-claims-provider-in-sharepoint.md ✅Succeeded View
docs/general-development/how-to-get-an-entire-workbook-or-a-snapshot.md ✅Succeeded View
docs/general-development/how-to-get-values-from-ranges.md ✅Succeeded View

docs/general-development/how-to-set-values-of-ranges.md

  • Line 41, Column 745: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/arrays#jagged-arrays' will be broken in isolated environments. Replace with a relative link.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates several SharePoint “general development” documentation articles to modernize links, fix formatting/typos, and add applicability/deprecation guidance for legacy APIs.

Changes:

  • Added IMPORTANT/NOTE callouts to clarify legacy/deprecated status and applicability (Excel Web Services, claims providers).
  • Fixed documentation code sample issues (VB.NET sample corrections, enum usage) and refreshed old MSDN links to learn.microsoft.com and /previous-versions/.
  • Cleaned up markdown formatting (code fence languages, whitespace/anchors cleanup, “See also” list formatting) and updated example URLs to https:// in some samples.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/general-development/how-to-set-values-of-ranges.md Adds legacy-tech warning, fixes link targets and formatting, updates some sample URLs and VB/C# snippets.
docs/general-development/how-to-get-values-from-ranges.md Adds legacy-tech warning, improves formatting and updates links/sample URLs.
docs/general-development/how-to-get-an-entire-workbook-or-a-snapshot.md Adds deprecation guidance and fixes VB sample enum usage plus link updates/format cleanup.
docs/general-development/how-to-deploy-a-claims-provider-in-sharepoint.md Adds on-prem-only applicability note, updates reference links, and fixes XML doc typos/formatting.
docs/general-development/how-to-create-an-odata-data-service-for-use-as-a-bcs-external-system.md Reformats/modernizes the article content, updates version/tool references, and refreshes external/internal links.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

@andrewconnell andrewconnell self-assigned this May 22, 2026
@andrewconnell andrewconnell added the pr:in-review Actively reviewing pull request label May 22, 2026
@andrewconnell andrewconnell self-requested a review May 22, 2026 18:23
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Comment thread docs/general-development/how-to-get-an-entire-workbook-or-a-snapshot.md Outdated
Comment thread docs/general-development/how-to-get-an-entire-workbook-or-a-snapshot.md Outdated
If fieldValues.Length <> rangeCoordinates.Height * rangeCoordinate.Width Then
Throw New Exception("The number of inputs (" &amp; fieldValues.Length &amp; ") does not match" &amp; " the product of Height (" &amp; rangeCoordinates.Height &amp; ") and Width (" &amp; rangeCoordinates.Width &amp; ")")
If fieldValues.Length <> rangeCoordinates.Height * rangeCoordinates.Width Then
Throw New Exception("The number of inputs (" & fieldValues.Length & ") does not match" & " the product of Height (" & rangeCoordinates.Height & ") and Width (" & rangeCoordinates.Width & ")")
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

- Ordered-list markers — normalized to repeated 1. style instead of 2./3./…
- Nested list formatting — tightened/normalized indentation of nested bullet lists
- Code-block indentation — reindented fenced code blocks from 4 spaces to 2
- Code-block whitespace — stripped trailing whitespace and removed trailing blank lines inside fenced blocks
- Blank-line collapsing — collapsed double/multiple blank lines (including runs before headings)
- Trailing whitespace — removed trailing whitespace in body prose
- Obsolete anchor targets — removed legacy <a name="bkmk_*"> anchors that had no inbound references
- ms.date reset — reverted to the original publication date (separate from formatting, but part of the same
commit)
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Copy link
Copy Markdown
Collaborator

@andrewconnell andrewconnell left a comment

Choose a reason for hiding this comment

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

I made multiple edits & waiting for the rebuild. Please review my comments below for future PRs.

Will check back on this one once the rebuild has completed to ensure the rendering is correct.

This article describes how to create an ASP.NET Windows Communication Foundation (WCF) Data Service to expose the AdventureWorks 2012 LT sample database. This enables you to access the data through the Open Data protocol (OData). When access is established through OData, you can configure a Business Connectivity Services (BCS) external content type that will enable SharePoint to consume the data from the external database. To further enhance this OData source, you can add service contracts to the WCF service that will enable BCS to subscribe to notifications that indicate that the external data has changed.

## Prerequisites for creating the OData service
<a name="bkmk_Prerequisites"> </a>
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

In the future, we need to remove these manual anchor links. Use what's automatically created by the MSDocs/MSLearn rendering engine (made easy via the MSLearn VSCode extension(s)


### To create a new WCF project

1. In Visual Studio, on the **File** menu, choose **New**, **Project**.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

In the future, numbered lists should use 1. for EVERY bullet point. Let the rendering engine generate the actual numbers.


### To add service operations for Subscribe and Unsubscribe stereotypes

- In the AdventureWorks.cs page, add the following string variable declaration.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Does this need to be a bullet point? Doesn't seem so because a single bullet != list.

If so, the code block after it should be nested under it.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Copy Markdown
Contributor

@andrewconnell andrewconnell added pr:ready-to-merge Ready to merge PR and removed pr:in-review Actively reviewing pull request labels Jun 1, 2026
@andrewconnell andrewconnell merged commit 1118071 into SharePoint:main Jun 1, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment