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 minor doc typos #715

Merged
merged 1 commit into from
Nov 6, 2023
Merged

Fix minor doc typos #715

merged 1 commit into from
Nov 6, 2023

Conversation

gil2rok
Copy link
Contributor

@gil2rok gil2rok commented Nov 6, 2023

Overview: Two minor documentation changes on the CmdStanPy workflow documentation page

  • remove period from middle of sentence
  • make link formatting consistent

for the optimization inference algorithm.

Details: More specifically, the documentation for every Stan inference algorithm on this documentation page, follows the form of "Stan's some algorithm", with a link to the algorithm itself.

However, the optimization algorithm is the only type of inference algorithm that includes the word "Stan" as part of the link. No other inference algorithm does this.

Submission Checklist

  • Run unit tests
  • Declare copyright holder and open-source license: see below

Summary

Copyright and Licensing

Please list the copyright holder for the work you are submitting (this will be you or your assignee, such as a university or company):

Simons Foundation

By submitting this pull request, the copyright holder is agreeing to license the submitted work under the following licenses:

Two documentation changes:

- remove period from middle of sentence
- make link formatting consistent

More specifically, the documentation for every Stan inference algorithm on this page, follows the form of "Stan's <some algorithm>", with a link to the algorithm itself.

However, the optimization algorithm is the only type of inference algorithm that includes the word "Stan" as part of the link. No other inference algorithm does this.
Copy link
Member

@bob-carpenter bob-carpenter left a comment

Choose a reason for hiding this comment

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

question about why not just linking directly and why escaping non-code as code

Copy link
Member

@WardBrian WardBrian left a comment

Choose a reason for hiding this comment

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

Thanks!

@WardBrian WardBrian merged commit 535c4e6 into stan-dev:develop Nov 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants