Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace lore's line-number example inclusion with class/function inclusion #11558

Closed
twisted-trac opened this issue Jun 3, 2005 · 7 comments
Closed

Comments

@twisted-trac
Copy link

glyph's avatar @glyph reported
Trac ID trac#1073
Type defect
Created 2005-06-03 08:51:26Z
Searchable metadata
trac-id__1073 1073
type__defect defect
reporter__glyph glyph
priority__high high
milestone__ 
branch__ 
branch_author__ 
status__closed closed
resolution__fixed fixed
component__lore lore
keywords__documentation__lore__EndOfLore documentation, lore, EndOfLore
time__1117788686000000 1117788686000000
changetime__1389977747000000 1389977747000000
version__ 
owner__ 
cc__glyph cc__radix cc__spiv cc__thijs
@twisted-trac
Copy link
Author

glyph's avatar @glyph commented
#!html
<pre>
Lore currently uses line-number offsets to point into examples.  This is wrong.
 It should use semantic ranges like classnames and function names.  This way you
don't need to update _every_ file that refers to it when you update example .py
files.
</pre>

@twisted-trac
Copy link
Author

radix's avatar @radix commented
#!html
<pre>
VERB
</pre>

@twisted-trac
Copy link
Author

glyph's avatar @glyph commented
#!html
<pre>
NOUN! (what?)

I'm not really the right person to do this.  Who is?  Hot potato time.
</pre>

@twisted-trac
Copy link
Author

radix's avatar @radix commented
#!html
<pre>
(VERB: it's good to have explanatory titles that contain a verb indicating what
action must be done :)

I guess I'll potato this over to spiv, unfortunately. I know he's not *really*
the maintainer of Lore, but he's still marked as it :)
</pre>

@twisted-trac
Copy link
Author

khorn's avatar @khorn set owner to @khorn

Sphinx supports including classes, functions and methods in this manner, so this should be fixed following the Sphinx conversion.

@twisted-trac
Copy link
Author

Automation's avatar Automation removed owner

@twisted-trac
Copy link
Author

khorn's avatar @khorn set status to closed

As we are now using Sphinx for documentation, following completion of #4500, this is effectively fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant