Opened 6 years ago

Closed 9 months ago

#3488 enhancement closed wontfix (wontfix)

Lore docs shouldn't use Twisted docs as an example of how to generate Lore docs

Reported by: kehander1 Owned by: khorn
Priority: normal Milestone:
Component: lore Keywords: documentation EndOfLore
Cc: thijs Branch:
Author: Launchpad Bug:

Description (last modified by exarkun)

lore.xhtml talks about how to generate the Twisted documentation. It gives an incorrect and incomplete example. It's really just doing this to give people an idea of how to use lore to generate docs. Instead of using Twisted as an example, it should use something simpler (and probably made up).

Attachments (1)

lorepaths.diff (419 bytes) - added by kehander1 6 years ago.

Download all attachments as: .zip

Change History (8)

Changed 6 years ago by kehander1

comment:1 Changed 6 years ago by kehander1

  • Type changed from enhancement to defect

comment:2 Changed 6 years ago by exarkun

  • Description modified (diff)
  • Keywords review removed

Even with the change, the documentation is still wrong. That command will only generate the core howto documentation, not all Twisted documentation.

Adjusting the ticket summary and description to reflect the real problem that needs to be solved.

comment:3 Changed 6 years ago by exarkun

  • Description modified (diff)
  • Summary changed from Wrong paths in Lore documentation to Lore docs shouldn't use Twisted docs as an example of how to generate Lore docs

Okay, after discussion on IRC, the lore docs just shouldn't talk about this. They can talk about how to generate the lore docs for a hypothetical example project though, that'd be good.

comment:4 Changed 6 years ago by thijs

  • Cc thijs added
  • Type changed from defect to enhancement

comment:5 Changed 6 years ago by thijs

Hm ok noticed now it was first marked as an enhancement and then changed to a defect but this isn't a defect imho, the explanation works as it is, it just could be improved.. oh well.

comment:6 Changed 4 years ago by exarkun

  • Owner changed from spiv to khorn

comment:7 Changed 9 months ago by khorn

  • Keywords EndOfLore added
  • Resolution set to wontfix
  • Status changed from new to closed

Lore is no longer being used for Twisted documentation, and is being deprecated, prior to eventual removal, per #6907.

This issue will not be fixed.

Note: See TracTickets for help on using tickets.