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

Documentation: printable cheat sheet including selected recipes #591

Closed
sadielbartholomew opened this issue Feb 6, 2023 · 2 comments · Fixed by #656
Closed

Documentation: printable cheat sheet including selected recipes #591

sadielbartholomew opened this issue Feb 6, 2023 · 2 comments · Fixed by #656
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@sadielbartholomew
Copy link
Member

sadielbartholomew commented Feb 6, 2023

Some libraries provide 'cheat sheets' i.e. summary reference pages, designed to be online or on-paper or both, summarising important parts of their library's API and/or functionality and/or outputs. They may be listed under other names than 'cheat sheet', but the principle is the same, e.g. ''10 Minutes to X' (or 'N minutes to X') pages are quite similar in scope.

It would be nice if we can have one of more cheat sheets for cf-python. They could include summaries of our core functionalities, some notable recipes, and , etc.

Ideally this would be available in a printable format, suitable for A3 or A4 size printing, so anyone old school or otherwise can print one out to refer to off-screen. It could be divided into beginner, intermediate and advanced sections or sheets also.

Nice examples I have seen recently as inspiration are:


This is something else you might want to work on at some point, @bewithankit!

@sadielbartholomew sadielbartholomew added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 6, 2023
@bewithankit
Copy link
Contributor

Wow! It'll be so cool to have one of these Cheat Sheets for cf-python! Thank you for the idea Sadie!

@bewithankit bewithankit self-assigned this Feb 6, 2023
@davidhassell
Copy link
Collaborator

Discussed this week off-line with @bewithankit ...

@davidhassell davidhassell added this to the 3.15.1 milestone Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants