Skip to content

consider using multiple source files#25

Merged
JonnyJD merged 4 commits into
masterfrom
package
Apr 23, 2013
Merged

consider using multiple source files#25
JonnyJD merged 4 commits into
masterfrom
package

Conversation

@JonnyJD
Copy link
Copy Markdown
Collaborator

@JonnyJD JonnyJD commented Apr 23, 2013

discid.py is now 600 lines long, we have a Disc/DiscId class that is quite big and are adding a Track class.
It might be wise to split these up in multiple files.

JonnyJD added 2 commits April 23, 2013 12:34
DiscId is still there (inherits from Disc), but a deprecation warning is
printed on stderr.
This should merge some module-level read fixes

Conflicts:
	discid.py
@ghost ghost assigned JonnyJD Apr 23, 2013
JonnyJD added 2 commits April 23, 2013 14:34
This splits the discid module into multiple modules:

libdiscid.py loads libdiscid and extracts the constants
disc.py is the Disc class and related functions (read/put)
util.py has utility functsions (_encode/_decode)
This way sphinx can access them.
Either way sphinx thinks they are defined in the discid package,
and tries to extract the "docstring" from there.
Actually the "docstring" is just sphinx reading the source in that case.

Another option would be to access them as disid.libdiscid.* in sphinx,
but that wouldn't document them as being in the main package.
@JonnyJD JonnyJD merged commit 41e7174 into master Apr 23, 2013
@JonnyJD JonnyJD deleted the package branch April 23, 2013 13:32
JonnyJD added a commit that referenced this pull request Apr 23, 2013
We only depend on libdiscid >= 0.2.2 so we display "libdicid < 0.4.0"
otherwise.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant