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

Config section type with static attributes (especially for core) #708

Closed
embolalia opened this issue Jan 11, 2015 · 8 comments
Closed

Config section type with static attributes (especially for core) #708

embolalia opened this issue Jan 11, 2015 · 8 comments
Labels
Milestone

Comments

@embolalia
Copy link
Contributor

We rarely remember to document core config options. One way to force ourselves to do so would be to create a special type for the core section which has a defined group of attributes and raises AttributeError on anything else. This way, any time we want to use a new config in the core section, we'd have to add it to that object, and thus document it. It might lead to a better way of documenting module configs, too (rather than markdown in their docstrings).

This should include reviewing how attributes are set with commands, to include appending and such.

@lramati
Copy link
Contributor

lramati commented Feb 24, 2015 via email

@embolalia
Copy link
Contributor Author

XML is not the solution here. Or anywhere, really. This can easily be built on top of the existing paradigm. My current plan is for "well-defined" config sections to be made as classes, the attributes of which use Python's descriptors to assert that their data is well-formed while interfacing with the same ConfigParser we know and love. Simple, Pythonic, and (most importantly to the issue at hand) able to be documented entirely with docstrings meaning they'll stay in sync every release the same way the API docs do, through sphinx.

@lramati
Copy link
Contributor

lramati commented Feb 25, 2015 via email

@embolalia
Copy link
Contributor Author

Modules left to port to the new config stuff are:

@elad661
Copy link
Contributor

elad661 commented Jun 23, 2015

regarding translate: drop the logging (kinda silly I named that thing "research needs"), drop collect lines.

@tyrope
Copy link

tyrope commented Jun 23, 2015

Radio could be dropped. We haven't used it in forever.

@embolalia
Copy link
Contributor Author

Okay; both are done.

I'll also be changing the auto accept invite in admin to true (people ask a lot), and deprecating wikipedia's lang_per_channel config option (per #827).

@embolalia
Copy link
Contributor Author

Wizard is currently busted, and there needs to be a thing for sasl auth mechanism, but other than that this is done.

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

No branches or pull requests

4 participants