Here is a typical example from cypress-examples. Any user reading the code later should understand what is going on from those comments. The users, if they copy your code would lose all context, right? Thus you need to generously add the code comments, hoping the would be included in the pasted code. Put yourself into the user's shoes and over-explain everything in the code example. Here is how I write code examples for cypress-grep - I show the destination filenames as comments. PasteBox Clipboard & snippet manager 2.2.1 Free Cracked. Ybin is based on the work of wonderful developer(s) behind an open-source encrypted pastebin project called ZeroBin (thank you). Show the filenameĪdd a comment showing the source filename where the snippet should go to avoid confusion. Pastebox is an easy, secure & anonymous way of sharing snippets of data such as code, text & logs. Would you recommend using Wt for creating pastebins Are there any examples. By providing the full file source code, I make it simple for someone to start right without going to the GitHub documentation to see how to write a workflow YML file, then come back to insert my cypress-io/ step there. Over 430 threads discussing labyrinth problems with over 1040 posters in support (thread 1702621) Thank you all GGG will implement a different method for ascension in PoE2. Im thinking of writing a pastebin with Wt. I use the complete file especially for the "hello world" examples, because if the user is interested in such example, they probably do not have a GitHub workflow file yet. # Install NPM dependencies, cache them correctly For example, in cypress-io/github-action every code example is the complete GitHub workflow file: 1 Put the full exampleĮven if you are showing a particular step of the process, try to put the complete code example on the page. In this blog post I will list my tips for making your code examples easier to find and use. This script is supported to read or highlight any kind of content smoothly and more understandably. They have added a button to every code block to copy its content with a single click. 29.00 PasteBox Text Sharing & Text Hosting Script is a Laravel script that allows pasting content, script, document, sensitive data, and source code for a certain period. I’m still getting used to it, but it may turn out to be my favorite. Good Clipboard Manager for Mac I have tried out several Mac clipboard managers and am presently trying out PasteBox as well. pastebox/ Go to file Go to fileT Go to lineL Copy path Copy This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. I feel like Ive died and gone to clipboard heaven. Using End-to-End Tests as DocumentationĮven GitHub now understands that copy and paste of code is super important. PasteBox is simple, clean, powerful, and easy-to-use.Check out these talks I gave where I discuss how to make good code examples and put them right in front of the users: Security & Encryption Details Modify the JavaScript encryption code to make it save your password. I agree :) That's why I spend so much time making my blog posts and code searchable. People joke that a senior software engineer is someone who knows how to Google and copy / paste examples from StackOverflow.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |