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

[Merged by Bors] - feat: add examples to docstrings #5815

Closed
wants to merge 1 commit into from

Conversation

kbuzzard
Copy link
Member


Open in Gitpod

The "natural transformation to the constant functor" thing always throws me; I've added the simple example which I am often imagining when I'm using this stuff.

@kbuzzard kbuzzard added documentation Improvements or additions to documentation awaiting-review The author would like community review of the PR labels Jul 11, 2023
Comment on lines +160 to +161
`c : Cocone F` is to give a collection of morphisms `ιⱼ : F j ⟶ c.pt` and, for
all `j ≤ k` in `J`, morphisms `ιⱼₖ : F j ⟶ F k` such that `Fⱼₖ ≫ Fₖ = Fⱼ` for all `j ≤ k`.
Copy link
Member

Choose a reason for hiding this comment

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

Out of curiosity, why do you use i \le j in the example above, and j \le k here?

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe it is to avoid visual confusion with iota?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes it was simply that

@semorrison
Copy link
Contributor

bors d+

@bors
Copy link

bors bot commented Jul 17, 2023

✌️ kbuzzard can now approve this pull request. To approve and merge a pull request, simply reply with bors r+. More detailed instructions are available here.

@github-actions github-actions bot added delegated and removed awaiting-review The author would like community review of the PR labels Jul 17, 2023
@kbuzzard
Copy link
Member Author

bors r+

bors bot pushed a commit that referenced this pull request Jul 17, 2023
@bors
Copy link

bors bot commented Jul 17, 2023

Pull request successfully merged into master.

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

@bors bors bot changed the title feat: add examples to docstrings [Merged by Bors] - feat: add examples to docstrings Jul 17, 2023
@bors bors bot closed this Jul 17, 2023
@bors bors bot deleted the kbuzzard-cone-docs branch July 17, 2023 23:40
semorrison pushed a commit that referenced this pull request Aug 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
delegated documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants