Skip to content

Remove the simple summary from the template#3564

Closed
axic wants to merge 1 commit intoethereum:masterfrom
axic:simple-summary
Closed

Remove the simple summary from the template#3564
axic wants to merge 1 commit intoethereum:masterfrom
axic:simple-summary

Conversation

@axic
Copy link
Member

@axic axic commented May 10, 2021

This has been removed from EIP-1 on 15-09-2019 in the PR #2186.

This has been removed from EIP-1 on 15-09-2019 in the PR ethereum#2186.
@alita-moore
Copy link
Contributor

Hi! I'm a bot, and I wanted to automerge your PR, but couldn't because of the following issue(s):

 - Filename eip-template.md is not in EIP format 'EIPS/eip-####.md'

@axic axic requested review from MicahZoltu and lightclient May 10, 2021 13:19
@MicahZoltu
Copy link

I believe that editor sentiment has changed since #2186, and we have come up with much better ways of describing the abstract vs title vs simple summary since then.

Though I originally found them confusing when I first got into EIP authoring, I have since gained a deeper understanding of their purpose and think they are valuable. I have also gotten much better at explaining the difference to users, which I think helps resolve the confusion that #2186 was trying to resolve.

@axic
Copy link
Member Author

axic commented May 10, 2021

Outside of sentiment, are you stating that the template has stronger authority than EIP-1? If so this PR is a material change, otherwise it is just a bugfix 😉

I suggest to create a PR which adds it to EIP-1 then and updates the description of both Abstract and Simple Summary in both places which resolves the confusion. Can you explain how would you describe them where it makes sense having both?

@MicahZoltu
Copy link

I think the effective operating procedure has precedent, and we should be updating the documentation to match that. Operating procedure for the last 9 months or so has been "Simple Summary is required", so the "bugfix" is EIP-1.

That being said, I recognize that it is very much non-ideal to have a different operating procedure from the documentation and it is certainly unfortunate that we got into this situation.

@gcolvin
Copy link
Contributor

gcolvin commented May 10, 2021

I once opposed having a simple summary, but I with @MicahZoltu on this now.

@lightclient
Copy link
Member

lightclient commented May 10, 2021

I'm in favor of having an optional simple summary. There are currently around 270 EIPs using it. I've opened a PR to update EIP-1 here: #3565

@axic
Copy link
Member Author

axic commented May 10, 2021

There are currently around 270 EIPs using it.

I think a large number of them had it before the #2186 change, and we did not change them obviously. Since then apparently @MicahZoltu was enforcing having them, hence the number.

The template currently says this:

"If you can't explain it simply, you don't understand it well enough." Provide a simplified and layman-accessible explanation of the EIP. Imagine an email subject line, GitHub PR title, or forum post title.

I want to emphasize Imagine an email subject line, GitHub PR title, or forum post title. If simple summary is a title, what is the title field we have? The same question was discussed in #2186.

If I can suggest one thing that would be rephrasing the explanation of abstract and simple summary so that it actually makes more sense than it does currently. (For example in the change #3541 which triggered this conversation, I would just duplicate the abstract as-is if this section is required if I have to go based on the above description. If the intent is something else, then I the explanation could be improved so that people understand it.)

@lightclient
Copy link
Member

@axic: yeah I think the template (and the old EIP-1 description) aren't the best ways of explaining the purpose of the "Simple Summary". I think large EIP greatly benefit from both sections. For example, EIP-1559 and EIP-2938 seem to do a good job of utilizing both. In the case of EIP-3541, I don't see a need for a "Simple Summary". The abstract is enough of a description. This is why I believe the "Simple Summary" section should be optional.

@axic
Copy link
Member Author

axic commented May 10, 2021

I wonder if actually the abstract should have the first paragraph as the "simple summary". A very large number of the 270 EIPs containing the simple summary have just a duplicated section.

Another idea which occurred to me is why not include a description field in the header serving as the summary. If the goal is to use this in "social media preview" renderings and the like, that seems to be a more relevant place.

@axic
Copy link
Member Author

axic commented May 10, 2021

Oh and I did a quick browse in the afternoon and there are plenty of (even recent) EIPs which do not have an abstract, only simple summary. Why weren't having abstracts enforced?

@lightclient
Copy link
Member

lightclient commented May 10, 2021

A very large number of the 270 EIPs containing the simple summary have just a duplicated section.

I definitely think this should be avoided.

Another idea which occurred to me is why not include a description field in the header serving as the summary. If the goal is to use this in "social media preview" renderings and the like, that seems to be a more relevant place.

That's a good idea.

Oh and I did a quick browse in the afternoon and there are plenty of (even recent) EIPs which do not have an abstract, only simple summary. Why weren't having abstracts enforced?

It appears even I'm guilty! I would say it's due to the lack of automated tools enforcing it.

@MicahZoltu
Copy link

Title: The thing people call it in a sentence. "What do you think about the EVM Versioning EIP?"

Simple Summary: The thing that shows up as the short description in lists, and is used to give a very brief overview to people who need a refresher. "Which one was the EVM Versioning EIP?" "It is the one that introduces a leading reserved byte for contracts."

Abstract: A human readable and terse description of the specification. This can leave out edge cases and gotchas, but by the time someone finishes reading the abstract they should have a very rough idea of what this EIP is proposing on a technical level. For very simple EIPs, it is acceptable to me that this mirrors the Simple Summary. The two may show up in different locations/contexts, and if the EIP is so simple that a one-liner can give a reader a technical understanding of it then great, use that sentence for both.

@github-actions
Copy link

There has been no activity on this pull request for two months. It will be closed in a week if no further activity occurs. If you would like to move this EIP forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review.

@github-actions github-actions bot added the stale label Jul 13, 2021
@github-actions
Copy link

This pull request was closed due to inactivity. If you are still pursuing it, feel free to reopen it and respond to any feedback or request a review in a comment.

@github-actions github-actions bot closed this Jul 20, 2021
@axic axic deleted the simple-summary branch August 11, 2021 10:56
@axic
Copy link
Member Author

axic commented Nov 11, 2021

This was replaced by #3706.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants