On Fri, 17 Apr 2020 18:01:42 -0400 Nick Mathewson nickm@freehaven.net wrote:
If you want to work on this it would be helpful to maybe start by listing (here or elsewhere) some places where you *don't* feel like you could (or would want to) write documentation: those would be a good target for devs who _have_ worked on Chutney before.
Sounds good, I will work on this.
Though I think this is likely to be an ongoing change that we see over time, since
Was this sentence supposed to be longer?
- More tests for the various parts of chutney, and refactoring to
make them more testable.
Internal unit testing seems like a good idea, yes.
- Making chutney comply with one or more of the python style
checking tools that are out there.
I can look into this; personally I have no experience with Python style-checking or linting tools, but now's a good time as ever for me to learn what is available and how it would work for Chutney.
This is an good vision for how Chutney should go; I really support this idea.
Glad you are on board :)
Caitlin
c c@chroniko.jp writes:
I can look into this; personally I have no experience with Python style-checking or linting tools, but now's a good time as ever for me to learn what is available and how it would work for Chutney.
For style-enforcement, things seem to be converging around "black" in the Python community (I personally haven't used it).
For linting it's flake8 (and also pylint or pyflakes). They all seem to come down to "how many warnings do you want to turn off". I have most-often used flake8 which is a fine choice.
Find me as "meejah" on #tor-dev if you want more random opinions from Python-land :)
On Fri, Apr 17, 2020 at 10:03 PM c c@chroniko.jp wrote:
On Fri, 17 Apr 2020 18:01:42 -0400 Nick Mathewson nickm@freehaven.net wrote:
Though I think this is likely to be an ongoing change that we see over time, since
Was this sentence supposed to be longer?
Yeah, I'm afraid I do that sometimes. I start composing a sentence, then think of something I want to write somewhere else, and then get distracted by a third sentence I ought to start. Usually, I come back and finish all the sentences. But sometimes I miss one or get distracted.
I think what I meant to say here was that we're going to need to keep refining the API as we work on implementation, since experience with an API can often show its deficiencies in a way that isn't apparent in advance.
best wishes,
-
c -
meejah -
Nick Mathewson