Ticket #506 (assigned enhancement )

Opened 5 years ago

Last modified 1 month ago

Update core examples listings

Reported by: hypatia Assigned to: thijs (accepted)
Type: enhancement Priority: low
Milestone: Component: core
Keywords: documentation Cc: spiv, thijs, exarkun
Branch: branches/core-examples-subdir-506 Author: thijs
Launchpad Bug:

Attachments

Change History

  2004-02-15 08:27:57+00:00 changed by hypatia 

The examples directory is quite large, and should probably be split into
subdirectories — if nothing else we could start auto-generating the
examples index.
Obviously doing this involves changing every howto that uses an example, and the
index.

  2004-11-20 16:46:30+00:00 changed by radix 

this has been alleviated since theh split, although doc/core/examples still has
47 entries.

  2006-06-24 23:15:47+00:00 changed by hypatia

  • cc changed from spiv, hypatia to spiv
  • owner changed from hypatia to edsuom
  • component set to core

  2008-07-09 21:08:30+00:00 changed by thijs

  • cc changed from spiv to spiv, thijs
  • branch deleted
  • author deleted

not sure what needs to happen here?

  2008-09-05 12:43:26+00:00 changed by thijs

  • owner changed from edsuom to thijs
  • status changed from new to assigned
  • launchpad_bug deleted
  • summary changed from Move examples into subdirectories to Move core examples into subdirectories

From today's IRC chat: 

exarkun: thijs: There are still a lot of examples in the core examples directory.
[14:34] exarkun: thijs: If having a lot of examples in one directory is bad, then the ticket is probably still valid.
[14:34] thijs: exarkun: ok, ill go through them
[14:34] exarkun: It's too bad the ticket doesn't explain why having a lot of examples in one directory is bad, though.
[14:34] thijs: so what about adding subdirs to that examples folder
[14:35] thijs: or does it suggest to move it to other projects
[14:36] exarkun: More the former than the latter

  2008-09-05 13:14:48+00:00 changed by thijs

  • branch set to branches/core-examples-subdir-506
  • author set to thijs

(In [24685]) Branching to 'core-examples-subdir-506'

  2008-09-05 16:21:07+00:00 changed by thijs

  • keywords changed from documentation to documentation, review
  • owner deleted
  • status changed from assigned to new

  2008-09-07 13:48:51+00:00 changed by exarkun

  • cc changed from spiv, thijs to spiv, thijs, exarkun
  • keywords changed from documentation, review to documentation
  • owner set to thijs

Building the docs fails. Lore docs link to howtos sometimes, and now all the paths are different.

I'd like to consider what the advantage of this change is before doing much more work on it (unless you don't mind doing the work and then hearing someone object to the whole thing :).

Are directories with 40 files in them really an impediment to learning? What problem is being solved here?

  2008-09-08 16:12:06+00:00 changed by thijs

  • status changed from new to assigned

I agree exarkun, there isn't much benefit with 40 files, but later on it can become an issue. Anyway, while working on this ticket I noticed some of the samples aren't listed in the .xhtml file, perhaps I can update that and forget about the directory changes?

  2008-10-21 09:37:28+00:00 changed by thijs

  • summary changed from Move core examples into subdirectories to Update core examples listings

Updating ticket title to make this ticket useful.

Note: See TracTickets for help on using tickets.