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

Suggestion: Make explicit the version of Erlang in the book #77

Open
hirotnk opened this issue Apr 20, 2017 · 11 comments
Open

Suggestion: Make explicit the version of Erlang in the book #77

hirotnk opened this issue Apr 20, 2017 · 11 comments

Comments

@hirotnk
Copy link
Collaborator

hirotnk commented Apr 20, 2017

As stated here, it may be helpful to explicitly state somewhere in the book which version it targets.
Then readers can guess about the contents of the book even after the implementation is changed later. Since sometimes there are major changes that affect the contents of this book.

@happi
Copy link
Owner

happi commented Apr 20, 2017

Yes, I have been thinking about this.
One problem is that right now there are old pieces of text written when Erlang was on version 14 and and 15 and newer parts that cover version 18 and 19.
Perhaps we would need to tag each chapter with which Erlang version it is updated to?

The goal right now is to cover Erlang 19 but we can not really state in the preface or introduction that the book covers 19 since some chapters have not been revised to that version.

I am all for making this information clear in some way so any suggestion on how to do it is welcome.

@garazdawi
Copy link
Contributor

I think a [NOTE] at the start of each chapter describing which version it was written for would be great.

@KronicDeth
Copy link
Contributor

OTP 21 changes how messages are added to other processes, but I'm not 💯 if the diagrams need to change.

@hirotnk
Copy link
Collaborator Author

hirotnk commented Mar 9, 2020

Agreed with @garazdawi 's comment above, I think just adding OTP version to [NOTE] would work. If there is more to say, we can always add descriptions to it.

As a side note, I tried to add some tags icon with right-aligned as below, but it did not work for pdf:

Screen Shot 2020-03-08 at 20 33 53

@happi
Copy link
Owner

happi commented Mar 11, 2020

How bad did it look in the PDF? (or did it not even build?)

@hirotnk
Copy link
Collaborator Author

hirotnk commented Mar 12, 2020

It built, but looks as below:
Screen Shot 2020-03-11 at 20 27 12

@happi
Copy link
Owner

happi commented Mar 12, 2020

Yes it might be a good time to update the build process. My plan is to get to finish the missing chapters in the near future and I will work more actively on the book now.

If you have some suggestions please let me know.

@hirotnk
Copy link
Collaborator Author

hirotnk commented Mar 13, 2020

The addition of missing chapters would be great. Does it help in any way to try to improve the formatting or layout at the moment, or better to wait for now?

@happi
Copy link
Owner

happi commented Mar 13, 2020

If you want to do it please go ahead, I would appreciate it.

@hirotnk
Copy link
Collaborator Author

hirotnk commented Mar 14, 2020

Got it.

@hirotnk
Copy link
Collaborator Author

hirotnk commented Apr 18, 2020

As part of #135, Admonition icon works in pdf as below:
Screen Shot 2020-04-18 at 3 02 23 PM

On HTML, it looks as below:
Screen Shot 2020-04-18 at 3 05 39 PM

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

No branches or pull requests

4 participants