Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Improve generated documentation for deprecated callables and types #605

Merged
bamarsha merged 8 commits into from
Oct 20, 2020
Merged

Improve generated documentation for deprecated callables and types #605

bamarsha merged 8 commits into from
Oct 20, 2020

Conversation

@bamarsha
Copy link
Contributor

@bamarsha bamarsha commented Sep 3, 2020 •
edited
Loading

  • Use the short summary for items shown on the namespace page (YamlMime:QSharpNamespace).
  • Preserve the long documentation string on the full page of a deprecated callable or type (YamlMime:QSharpType).

Here is what it looks like on the docs site.

Resolves #592.

@bamarsha bamarsha changed the title Swap use of short and long summaries in generated documentation Fix use of short and long summaries for deprecated items in generated documentation Sep 3, 2020
@bamarsha bamarsha mentioned this pull request Sep 3, 2020
Closed
@bamarsha bamarsha changed the title Fix use of short and long summaries for deprecated items in generated documentation Fix use of short summaries for deprecated items in generated documentation Sep 3, 2020
@bamarsha bamarsha marked this pull request as draft September 3, 2020 21:38
@microsoft-github-updates microsoft-github-updates bot changed the base branch from master to main September 9, 2020 07:51
@bamarsha bamarsha changed the title Fix use of short summaries for deprecated items in generated documentation Improve generated documentation for deprecated callables and types Oct 13, 2020
@bamarsha bamarsha marked this pull request as ready for review October 13, 2020 23:00
@bamarsha bamarsha requested a review from bettinaheim October 13, 2020 23:01
bettinaheim
bettinaheim approved these changes Oct 20, 2020
View reviewed changes
Copy link
Contributor

@bettinaheim bettinaheim left a comment

Choose a reason for hiding this comment

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

Lgtm. I assume you checked the docs page?

@bamarsha
Copy link
Contributor Author

bamarsha commented Oct 20, 2020

Yes, an example of the rendered docs page is in the PR description.

@bamarsha bamarsha merged commit 90fcb62 into main Oct 20, 2020
@bamarsha bamarsha deleted the samarsha/deprecated-summary branch October 20, 2020 23:15
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@cgranade cgranade Awaiting requested review from cgranade

@tcNickolas tcNickolas Awaiting requested review from tcNickolas

1 more reviewer

@bettinaheim bettinaheim bettinaheim approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Preserve API documentation on deprecated operations

3 participants

@bamarsha @bettinaheim