Skip to content

EIP-1: remove requirement for simple summary#2186

Merged
nicksavers merged 1 commit intoethereum:masterfrom
axic:eip1-summary
Sep 15, 2019
Merged

EIP-1: remove requirement for simple summary#2186
nicksavers merged 1 commit intoethereum:masterfrom
axic:eip1-summary

Conversation

@axic
Copy link
Member

@axic axic commented Jul 10, 2019

No description provided.

@axic
Copy link
Member Author

axic commented Jul 10, 2019

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?

@axic
Copy link
Member Author

axic commented Jul 10, 2019

cc @nicksavers @Arachnid @karalabe @fjl

@xinbenlv
Copy link
Contributor

+1

@nicksavers
Copy link
Contributor

@axic Can you give examples of where they are redundant?
And any examples where they actually add value?

@axic
Copy link
Member Author

axic commented Jul 13, 2019

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.

@nicksavers
Copy link
Contributor

It's actually pretty nice to have a simple TL;DR of the proposal up front in one or two lines.
The last two examples given are pretty useful to me, but I agree not all are equally useful. I'm not yet convinced. I think it's mostly a deterrent for those that haven't fully understood their own proposal yet.

In EIP-615 it's much better in my opinion.

@axic
Copy link
Member Author

axic commented Jul 15, 2019

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?

@xinbenlv
Copy link
Contributor

xinbenlv commented Jul 15, 2019

@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?

@Arachnid
Copy link
Contributor

@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?

@xinbenlv
Copy link
Contributor

xinbenlv commented Jul 16, 2019

@Arachnid:
if I may us ERC-20 as an example

What this EIP does:

A standard interface for tokens.

How it does

The following standard allows for the implementation of a standard API for tokens within smart contracts. This standard provides basic functionality to transfer tokens, as well as allow tokens to be approved so they can be spent by another on-chain third party.

@Arachnid
Copy link
Contributor

@xinbenlv It seems to me that the former makes a good title, while the latter makes a good abstract.

@xinbenlv
Copy link
Contributor

@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:

  • Simple Summary -> Title
  • Abstract -> (remain) Abstract

I am also supporting this idea.

@Arachnid
Copy link
Contributor

Well, we already have a title, so this proposal devolves to the same one @axic started with - drop 'simple summary'.

@xinbenlv
Copy link
Contributor

Cool, I am for that too.

@nicksavers : WDYT? if you agree, then we have consensus on this issue.

@axic
Copy link
Member Author

axic commented Jul 17, 2019

@nicksavers ping

@axic
Copy link
Member Author

axic commented Jul 25, 2019

@nicksavers what should happen to this one?

@axic
Copy link
Member Author

axic commented Aug 8, 2019

@nicksavers can we merge this or do you have an objection?

@axic
Copy link
Member Author

axic commented Sep 5, 2019

@nicksavers ping

@axic
Copy link
Member Author

axic commented Sep 10, 2019

@Arachnid @nicksavers @Souptacular @gcolvin can this be merged?

@axic axic requested a review from nicksavers September 15, 2019 17:38
@nicksavers nicksavers merged commit 81b36ca into ethereum:master Sep 15, 2019
@nicksavers
Copy link
Contributor

I still think here is a slight difference, but not big enough to break consensus.

@axic axic deleted the eip1-summary branch September 15, 2019 18:03
ilanolkies pushed a commit to ilanolkies/EIPs that referenced this pull request Nov 12, 2019
MadeofTin pushed a commit to MadeofTin/EIPs that referenced this pull request Nov 13, 2019
@axic axic mentioned this pull request Aug 28, 2020
tkstanczak pushed a commit to tkstanczak/EIPs that referenced this pull request Nov 7, 2020
Arachnid pushed a commit to Arachnid/EIPs that referenced this pull request Mar 6, 2021
axic added a commit to axic/EIPs that referenced this pull request May 10, 2021
This has been removed from EIP-1 on 15-09-2019 in the PR ethereum#2186.
axic added a commit to axic/EIPs that referenced this pull request Aug 11, 2021
This has been removed from EIP-1 on 15-09-2019 in the PR ethereum#2186.
axic added a commit to axic/EIPs that referenced this pull request Aug 16, 2021
This has been removed from EIP-1 on 15-09-2019 in the PR ethereum#2186.
axic added a commit to axic/EIPs that referenced this pull request Aug 17, 2021
This has been removed from EIP-1 on 15-09-2019 in the PR ethereum#2186.
axic added a commit to axic/EIPs that referenced this pull request Aug 17, 2021
This has been removed from EIP-1 on 15-09-2019 in the PR ethereum#2186.
MicahZoltu pushed a commit that referenced this pull request Aug 17, 2021
* 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
PhABC pushed a commit to PhABC/EIPs that referenced this pull request Jan 25, 2022
* 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
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.

5 participants