Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(186)

Delta Between Two Patch Sets: Documentation/web/community.itexi

Issue 4636082: an example of minimal example (Closed)
Left Patch Set: ignore previous patch set, i forgot to pull Created 13 years, 8 months ago
Right Patch Set: fix aligning of the example. Created 13 years, 8 months ago
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
Left: Side by side diff | Download
Right: Side by side diff | Download
LEFTRIGHT
1 @c -*- coding: utf-8; mode: texinfo; -*- 1 @c -*- coding: utf-8; mode: texinfo; -*-
2 @ignore 2 @ignore
3 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH 3 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
4 4
5 When revising a translation, copy the HEAD committish of the 5 When revising a translation, copy the HEAD committish of the
6 version that you are working on. For details, see the Contributors' 6 version that you are working on. For details, see the Contributors'
7 Guide, node Updating translation committishes.. 7 Guide, node Updating translation committishes..
8 @end ignore 8 @end ignore
9 9
10 @include included/authors.itexi 10 @include included/authors.itexi
(...skipping 266 matching lines...) Expand 10 before | Expand all | Expand 10 after
277 @subheading Why create them? 277 @subheading Why create them?
278 278
279 @divClass{keep-bullets} 279 @divClass{keep-bullets}
280 @itemize 280 @itemize
281 281
282 @item 282 @item
283 The simpler the example is, the quicker potential helpers can 283 The simpler the example is, the quicker potential helpers can
284 understand it and help you. 284 understand it and help you.
285 285
286 @item 286 @item
287 A simple example demonstrates that you have put effort towards 287 A tiny example demonstrates that you have put effort towards
288 solving the problem yourself. When people send huge portions of 288 solving the problem yourself. When people send huge portions of
289 input, it looks like they don't care how if we help them or not. 289 input, it looks like they don't care if we help them or not.
290 290
291 @item 291 @item
292 Creating a tiny example forces you to understand what is 292 Creating a tiny example helps you to understand what is
293 happening. Many false problem reports can be avoided by 293 happening. Many false problem reports can be avoided by
294 attempting to create a tiny example; if you cannot replicate a 294 attempting to create a tiny example; if you cannot replicate a
295 @qq{bug} in a tiny example, then the problem was probably an 295 @qq{bug} in a tiny example, then the problem was probably an
296 insufficient understanding of LilyPond, not an actual bug! 296 insufficient understanding of LilyPond, not an actual bug!
297 297
298 @end itemize 298 @end itemize
299 @divEnd 299 @divEnd
300 300
301 @divEnd 301 @divEnd
302 302
303 303
304 @divClass{column-right-bottom} 304 @divClass{column-right-bottom}
305 @subheading How do I create them? 305 @subheading How to create them?
306 306
307 @divClass{keep-bullets} 307 @divClass{keep-bullets}
308 @itemize 308 @itemize
309 309
310 @item 310 @item
311 Include the \version number. 311 Include the @code{\version} number.
312 312
313 @item 313 @item
314 Make it small! Examples about spacing or page layout might 314 Make it small! Examples about spacing or page layout might
315 require many bars of music, but most issues can be reproduced 315 require many bars of music, but most issues can be reproduced
316 using less than a single measure. 316 using less than a single measure.
317 317
318 @item 318 @item
319 When trying to create an example, try commenting out @w{(@code{%} 319 When trying to create an example, try commenting out @w{(@code{%}
320 or @code{%@{ @dots{} %@}})} sections of your file. If you can 320 or @code{%@{ @dots{} %@}})} sections of your file. If you
321 comment something while still demonstrating the main idea, then 321 can comment something while still demonstrating the main idea,
322 remove the commented-material! 322 then remove the commented-material.
323 323
324 @item 324 @item
325 Avoid using complicated notes, keys, or time signatures, unless 325 Avoid using complicated notes, keys or time signatures, unless
326 the bug is about the behavior of those items. 326 the bug is about the behavior of those items.
327 327
328 @item 328 @item
329 Do not use @code{\override} or @code{\set} commands unless the bug 329 Do not use @code{\override} or @code{\set} commands unless the bug
330 is about those particular commands. 330 is about those specific commands.
331 331
332 @item 332 @item
333 If possible, attach an image showing what do you want to achieve 333 Optionally, attach an image showing the desired graphical output.
334 (how the correct output should look like).
335 334
336 @end itemize 335 @end itemize
337 @divEnd 336 @divEnd
338 337
339 @divEnd 338 @divEnd
340 339
341 @divClass{column-center-bottom} 340 @divClass{column-center-bottom}
342 @subheading How tiny should they be? 341 @subheading How tiny should they be?
343 342
344 Is the code below a minimal example? 343 Is the code below a minimal example?
(...skipping 534 matching lines...) Expand 10 before | Expand all | Expand 10 after
879 878
880 @contactUsAbout{academic papers} 879 @contactUsAbout{academic papers}
881 880
882 881
883 @node Old news 882 @node Old news
884 @unnumberedsec Old news 883 @unnumberedsec Old news
885 884
886 @include web/news-front.itexi 885 @include web/news-front.itexi
887 886
888 @include web/news.itexi 887 @include web/news.itexi
LEFTRIGHT

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b