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

Replace examples projects with documentation or recipes #1917

Closed
blairconrad opened this issue Mar 22, 2023 · 1 comment · Fixed by #1919
Closed

Replace examples projects with documentation or recipes #1917

blairconrad opened this issue Mar 22, 2023 · 1 comment · Fixed by #1919

Comments

@blairconrad
Copy link
Member

Inspired by a comment I made in PR 1915.

We could convert examples to be a test-like project instead of adding a new one. Alternatively, could say "Hey! The examples were useful back when we had no docs, and are pretty thin now. What if we just made sure everything was documented or a recipe, if deserving, and remove that project". (Then again, if we added recipes to the "Examples*" project(s) (under "sample", which I never noticed before, we could still thin them out later if we wanted.)

Based on my actions, I slightly preferred a new [recipes] project (and removing the old ones)

So, once we have runnable recipes that are included in the docs via snippets, we should examine the examples projects and see if they still provide value. For each example, we should be able to

  1. find it in the docs, or
  2. add it to the docs (as a recipe or not)

and then remove it!

@github-actions
Copy link

This change has been released as part of FakeItEasy 7.4.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant