Skip to content

docs: Language guide for libraries#104

Merged
maximilianruesch merged 13 commits into
mainfrom
mr/docs/libraries-guide
Apr 22, 2026
Merged

docs: Language guide for libraries#104
maximilianruesch merged 13 commits into
mainfrom
mr/docs/libraries-guide

Conversation

@maximilianruesch

@maximilianruesch maximilianruesch commented Apr 17, 2026

Copy link
Copy Markdown
Contributor
image

Closes #103

@CalMacCQ

Copy link
Copy Markdown
Collaborator

Did you intentionally target the cm/guppylang0.21.12 branch rather than main?

@maximilianruesch

Copy link
Copy Markdown
Contributor Author

Yes. This is to signal that we should make the remainder of the documentation update available first before we merge the language guide. Even more so now that the release with libraries in it was pulled.

@maximilianruesch maximilianruesch force-pushed the mr/docs/libraries-guide branch from 56a287c to 9d9cacd Compare April 21, 2026 12:58
@maximilianruesch maximilianruesch changed the base branch from cm/guppylang0.21.12 to main April 21, 2026 12:59
@maximilianruesch maximilianruesch marked this pull request as ready for review April 21, 2026 13:03

@CalMacCQ CalMacCQ left a comment

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.

Looks very nice. Thanks for adding this section.

A few minor comments.

from guppylang.std.builtins import result
from hugr.package import Package

# --- SNIP ---

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.

What is the purpose of these --- SNIP --- lines? Did you intend for them to show up in the html pages like this?

Image

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

They are intended to show that the displayed code is not something that adds meaning for this section, but rather as a refresher from some other (earlier) code snippet on the page. Called SNIP to signify how someone would could the code with a scissor to insert it here.

Comment thread sphinx/language_guide/libraries.md Outdated
Comment thread sphinx/language_guide/libraries.md
Comment thread sphinx/language_guide/libraries.md Outdated
Comment thread sphinx/language_guide/libraries.md Outdated
Comment thread sphinx/language_guide/libraries.md Outdated

@CalMacCQ CalMacCQ left a comment

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.

Thanks Max, happy to have this merged

@maximilianruesch maximilianruesch merged commit 5859c2c into main Apr 22, 2026
3 checks passed
@maximilianruesch maximilianruesch deleted the mr/docs/libraries-guide branch April 22, 2026 14:15
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.

[Docs]: Document Guppy libraries

2 participants