Feedback on Code Examples?

Hey everyone! We’re working on some improvements to Code Examples based on your feedback so I wanted to quickly open a thread to document the most common feedback we’ve received so far.

The last major update to code examples was Concise code examples.

The most common complaints we’ve heard since then:

  • Concise code examples are sometimes incomplete
    • For example, a user might’ve implemented most of the functionality for the current stage while working on the previous ones. Their diff will naturally be more “concise” that others, but it would be incomplete.
  • It’s hard to find code examples that follow “Best practices”
    • Code that follows best practices is often not the most concise, so one has to wade through the chronological list to find such examples.
  • Concise code examples are often duplicates
    • This is particularly common with earlier stages where diffs are small and code doesn’t diverge much
  • Can’t “save” / “bookmark” code examples
    • Once you’ve found a good code example, there’s no way to “save” it. These might disappear over time as new ones are added to the list.
  • Can’t “follow” code examples from a specific user
    • If you find a good code example from a user in one stage, it’s not always possible to find their examples on the next stage.
  • Can’t access unchanged files in code examples
    • Some code examples contain code that references another file that’s unchanged and hence can’t be viewed
    • Currently we only allow viewing the full repository if it is published to GitHub

We’ve working on addressing most of these in the coming weeks. The hardest to tackle is probably identifying “Best practices” code examples. I think it’ll be an interesting problem to solve — looking forward to sharing a write-up once we’re done.

If you have anything to add to this list, or just feedback to share in general, please do chime in!

3 Likes