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

WIP: Add programmatic constraint examples & surface in docs #810

Merged
merged 19 commits into from
Oct 16, 2023

Conversation

SeanKilleen
Copy link
Member

Supports #794.

Starting with the low-hanging fruit first. Getting the table cleaned up, getting some basic examples into programmatic format, and seeing how to best surface them in the main list.

Copy link
Member Author

@SeanKilleen SeanKilleen left a comment

Choose a reason for hiding this comment

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

Hmm, a bit of a bummer on the main page front. I was hoping to show the same programmatic snippets in a column using the same code that displays on the page itself. But this is a bit too far a stretch for docfx or similar editors.

So, I think for now, for each constraint I'll aim to get:

  • A programmatic example in snippets within the article
  • Pseudo-code examples in the Quick example column.

@SeanKilleen
Copy link
Member Author

SeanKilleen commented Oct 16, 2023

Ping @OsirisTerje just to make sure I'm going about this in an OK way in line with how we talked about it. I think I'm heading in the right direction but better to ask earlier than later. :)

Copy link
Member

@OsirisTerje OsirisTerje left a comment

Choose a reason for hiding this comment

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

LVGTM

@OsirisTerje OsirisTerje merged commit 5c1d71a into master Oct 16, 2023
6 of 7 checks passed
@OsirisTerje OsirisTerje deleted the 794_constraint-examples branch October 16, 2023 07:27
@OsirisTerje OsirisTerje restored the 794_constraint-examples branch October 16, 2023 07:35
@OsirisTerje
Copy link
Member

OsirisTerje commented Oct 16, 2023

@SeanKilleen Sorry, was a bit too fast there :-) Shame on me. Branch restored, so please continue ----

Reverted the squash commit in master.

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.

2 participants