Ticket #2881 (new defect)

Opened 21 months ago

Last modified 21 months ago

Remove or improve 'Domain Model' docs page

Reported by: seanh Owned by:
Priority: awaiting triage Milestone: ckan-v1.8.1
Component: ckan Keywords: docs
Cc: Repository: ckan
Theme: none

Description (last modified by seanh) (diff)


Currently not very useful. Also these pages:




This just seems very incomplete to me (surely there is more to the domain model the dataset, resource and task status?) and very likely to not get updated as changes are mode to the code. Would anyone seriously refer to this rather than just looking at the source code?

If we want to have something along these lines in the docs, I suggest adding docstrings to packages, modules, classes and methods and then using autodoc to pull them into sphinx.

Change History

comment:1 Changed 21 months ago by seanh

  • Description modified (diff)

comment:2 Changed 21 months ago by seanh

  • Description modified (diff)

comment:3 Changed 21 months ago by seanh

  • Description modified (diff)

comment:4 Changed 21 months ago by rgrp

@seanh - this was the material from the wiki moved to the docs. I agree it is somewhat incomplete but we certainly shouldn't remove it without something better in place.

Also, IMO this is currently very low priority ...

Note: See TracTickets for help on using tickets.