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

docs: stub out new script documentation #1602

Merged
merged 12 commits into from
Oct 16, 2016
Merged

Conversation

cortesi
Copy link
Member

@cortesi cortesi commented Oct 6, 2016

Also change TCP-related event names for clarity

@cortesi cortesi changed the title docs: stub out new script documentation [wip] docs: stub out new script documentation Oct 6, 2016
@cortesi cortesi force-pushed the scriptdocs branch 3 times, most recently from bbcb00f to 0971e05 Compare October 16, 2016 05:50
cortesi and others added 11 commits October 16, 2016 20:26
- Hide links to internal code listings, and link to github instead
- Improve formatting of code/example captions
- Fix outdated documentation of command-line options
- Complete documentation of all events + improved formatting
- tcp_open -> tcp_start, tcp_close -> tcp_end to reduce confusion
- We don't need a deprecation warning here
- Bring imports inline with policy
Add the terminal logger before any other addons, so we see script errors on
startup.
This is so we can see the effects of script rewriting using -dd.
We need scripts to run _before_ filestreamer, so we can't just add them to the
end of the chain. This patch also fixes an issue that could cause scripts to be
initialised un-necessarily if only the order of scripts in options changed.
@codecov-io
Copy link

Current coverage is 80.84% (diff: 93.75%)

Merging #1602 into master will increase coverage by 0.03%

@@             master      #1602   diff @@
==========================================
  Files           143        143          
  Lines         12342      12351     +9   
  Methods           0          0          
  Messages          0          0          
  Branches       2016       2018     +2   
==========================================
+ Hits           9973       9985    +12   
+ Misses         2087       2085     -2   
+ Partials        282        281     -1   

Powered by Codecov. Last update 26af9b2...0971e05

@cortesi cortesi changed the title [wip] docs: stub out new script documentation docs: stub out new script documentation Oct 16, 2016
@cortesi cortesi merged commit e4a32d6 into mitmproxy:master Oct 16, 2016
@cortesi cortesi deleted the scriptdocs branch March 19, 2017 00:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants