EIP-1: remove requirement for simple summary#2186
Conversation
|
My reasoning: abstract and simple summary kind of is the same thing. For a while there was a suggestion that "simple summary" is a non-technical description and "abstract" is a technical description, but inevitably it results in duplication and a lot of people feel it as a burden without any benefits. Question: should existing simple summaries removed from merged EIPs? |
|
+1 |
|
@axic Can you give examples of where they are redundant? |
|
Examples where they are redundant, based on opening random EIPs: 1203, 1538, 1973. @nicksavers I have yet to find an example where it is useful to have both. |
|
It's actually pretty nice to have a simple TL;DR of the proposal up front in one or two lines. In EIP-615 it's much better in my opinion. |
|
Well EIP-1 gives no explanation about the difference. When asked, I've kept saying "simple summary is a non-technical description, while abstract is a technical description". Making it mandatory creates some tension and in most of the cases it results in an extra useless section. I have nothing against leaving it in optionally, but not sure it provides enough value. Why shouldn't just the abstract start out with a single clear sentence explaining what it is? |
|
@nicksavers @axic: so do I understand it correctly: Simple Summary = What this EIP does Abstract = How this EIP technically does it If separating them is the purpose, how about we re-phrase Abstract to Technical Outline, etc., so the difference between it and the Simple Summary is more obvious? |
|
@xinbenlv I don't think the abstract is intended to describe how the standard 'does it'. It's not clear to me that it's possible to write a clean summary of that in a couple of sentences anyway. Without looking at the current standard, how would you write a simple summary and abstract for ERC20, for example? |
|
@Arachnid: What this EIP does:
How it does
|
|
@xinbenlv It seems to me that the former makes a good title, while the latter makes a good abstract. |
|
@Arachnid agree. I actually think that in most academic articles I've personally seen or in other context, a "Abstract" will usually contain those information. If you are proposing that:
I am also supporting this idea. |
|
Well, we already have a title, so this proposal devolves to the same one @axic started with - drop 'simple summary'. |
|
Cool, I am for that too. @nicksavers : WDYT? if you agree, then we have consensus on this issue. |
|
@nicksavers ping |
|
@nicksavers what should happen to this one? |
|
@nicksavers can we merge this or do you have an objection? |
|
@nicksavers ping |
|
@Arachnid @nicksavers @Souptacular @gcolvin can this be merged? |
|
I still think here is a slight difference, but not big enough to break consensus. |
This has been removed from EIP-1 on 15-09-2019 in the PR ethereum#2186.
This has been removed from EIP-1 on 15-09-2019 in the PR ethereum#2186.
This has been removed from EIP-1 on 15-09-2019 in the PR ethereum#2186.
This has been removed from EIP-1 on 15-09-2019 in the PR ethereum#2186.
This has been removed from EIP-1 on 15-09-2019 in the PR ethereum#2186.
* Add description field to the EIP header * Update 2718 * Move description rendering to below the title * Remove the simple summary from the template This has been removed from EIP-1 on 15-09-2019 in the PR #2186. * Update title/description/abstract with new recommendation * Mention length limit of description
* Add description field to the EIP header * Update 2718 * Move description rendering to below the title * Remove the simple summary from the template This has been removed from EIP-1 on 15-09-2019 in the PR ethereum#2186. * Update title/description/abstract with new recommendation * Mention length limit of description
No description provided.