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.

Sign up for GitHub

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

Jump to bottom

Markup mistake in Remarks section #18025

Closed
JeffEmery opened this issue Jan 16, 2021 · 6 comments
Closed

Markup mistake in Remarks section #18025

JeffEmery opened this issue Jan 16, 2021 · 6 comments
Assignees
@jsquire @danieljurek
Labels
Central-EngSys This issue is owned by the Engineering System team. Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Service Bus

Comments

@JeffEmery
Copy link

The Remarks section has a mistake where part of the sentence is inside a code block.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
@ghost ghost added needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. customer-reported Issues that are reported by GitHub users external to the Azure organization. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Jan 16, 2021
@jsquire
Copy link
Member

jsquire commented Jan 16, 2021

Hi @JeffEmery. Thank you for your feedback. We'll get this patched up.

@jsquire jsquire self-assigned this Jan 16, 2021
@jsquire jsquire added Client This issue points to a problem in the data-plane of the library. Docs needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team Service Bus labels Jan 16, 2021
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Jan 16, 2021
@jsquire
Copy link
Member

jsquire commented Jan 16, 2021

@scbedd: I'd appreciate your thoughts here. The MS Docs content is definitely malformed, but the code comments are valid. The only difference that I can see from other areas is that the <remarks> tags are inline with a multi-line comment rather than being on a separate line.

//cc: @JoshLove-msft

@jsquire jsquire mentioned this issue Jan 19, 2021
Merged
@jsquire
Copy link
Member

jsquire commented Jan 20, 2021

I think this should be fixed by #18063. @scbedd: Is there a way that we can regen and validate without waiting for a release?

@danieljurek danieljurek added the Central-EngSys This issue is owned by the Engineering System team. label Feb 4, 2021
@danieljurek
Copy link
Member

Investigation revealed that inconsistencies in spaces between the start of doc comments is causing the DocFX to render markdown in unintended ways. We are testing a limited fix #18485

This may be happening in more places throughout the code. If it is happening in other places in the code it makes sense to consider language-specific automation that enforces correct spacing practices in doc comments.

@danieljurek
Copy link
Member

Update -- We have had an internal tools issue opened to track fixing this: https://ceapex.visualstudio.com/Engineering/_workitems/edit/373096

The team has triaged this and will be working on a feature which should fix the behavior. I'm following up.

@jsquire jsquire mentioned this issue Apr 27, 2021
Merged
@danieljurek
Copy link
Member

Verified formatting looks good -- https://docs.microsoft.com/en-us/dotnet/api/azure.messaging.servicebus.servicebusmessage.scheduledenqueuetime?view=azure-dotnet#Azure_Messaging_ServiceBus_ServiceBusMessage_ScheduledEnqueueTime

@github-actions github-actions bot locked and limited conversation to collaborators Mar 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jsquire jsquire

@danieljurek danieljurek

Labels
Central-EngSys This issue is owned by the Engineering System team. Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Service Bus
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@jsquire @danieljurek @JeffEmery @scbedd