Ticket #1189 (assigned bug)

Opened 2 years ago

Last modified 2 years ago

On-line scripting reference should be cleaned up slightly

Reported by: admackin Owned by:
Milestone: Component: documentation
Severity: minor Keywords:
Cc: Blocking:
Blocked By:

Description

I'm currently using Orange 2.5a4 but I've found a few problems with the documentation:

  • The online reference doesn't specify what version it applies to. I eventually found the PCA code I was looking for at Orange.projection.pca.Pca which is fine but confusing when the  docs point me to Orange.projection.linear.Pca. I presume this is due to version mismatch, but without a version noted anywhere (at least that I could find) in the online reference, it was difficult to know to even look out for this.
  • The  reference index is broken – all links point to 404s
  • The PyPi page links to  http://orange-bioinformatics.readthedocs.org which mostly unpopulated and therefore not very useful. It would be better to point to the documentation on the main site, or keep the reasdthedocs.org page updated

Change History

comment:1 Changed 2 years ago by ales

  • Status changed from new to assigned
  • Owner set to mitar

comment:2 in reply to: ↑ description Changed 2 years ago by mitar

  • Owner mitar deleted

Replying to admackin:

  • The online reference doesn't specify what version it applies to. I eventually found the PCA code I was looking for at Orange.projection.pca.Pca which is fine but confusing when the  docs point me to Orange.projection.linear.Pca. I presume this is due to version mismatch, but without a version noted anywhere (at least that I could find) in the online reference, it was difficult to know to even look out for this.

Version is latest from the repository. Yes. It should be probably mentioned. But probably the best would be to move to readthedocs and have simply multiple versions there.

Thanks.

  • The PyPi page links to  http://orange-bioinformatics.readthedocs.org which mostly unpopulated and therefore not very useful. It would be better to point to the documentation on the main site, or keep the readthedocs.org page updated

We have not yet moved HTML files to RST files. We are in progress of moving documentation there, so sorry for chaos now.

I will mention all this on our weekly meeting. We should probably really just do some effort to move everything to readthedocs. Will discuss it.

Note: See TracTickets for help on using tickets.