Format keywords with monospace font - Githubissues

jakartaee / transactions

Welcome to the Jakarta EE Transactions API Project (formerly JTA)

https://jakartaee.github.io/transactions/

Other

29 stars 30 forks source link

Format keywords with monospace font #176

Closed hussainnm closed 4 years ago

hussainnm commented 4 years ago

Remove version when referencing components of other Jakarta technologies
Change cross references to readable id
Change keywords from italics to monospace

jta-bot commented 4 years ago

Can one of the admins verify this patch?

tomjenkinson commented 4 years ago

ok to test

tomjenkinson commented 4 years ago

retest this please

tomjenkinson commented 4 years ago

I have asked about the version numbers which should have appeared on https://www.eclipse.org/lists/jakartaee-spec-project-leads/2020/Sep/index.html but I don't see it yet. I copied jta-dev (https://www.eclipse.org/lists/jta-dev/msg00151.html)

tomjenkinson commented 4 years ago

I am holding on this a bit until we get some clarity on removing those version numbers. I think the reformatting of the document could be helpful because I saw some extraneous "_" in the current state and I think that this might correct that. Let's see if we get any negative feedback on removing the version numbers though (unless you would like to split that to a different PR and I can review this independent of that? Thanks!

hussainnm commented 4 years ago

Just to clarify, the version numbers that I have removed are only when referencing a component of a Jakarta technology and not the actual specification. If the specification is being referred to then version must be mentioned. All such references are maintained as-is.

tomjenkinson commented 4 years ago

Sorry I missed that! I will follow up on the thread I created as I don't think duplicating the version numbers inline in the text is particularly necessary.

tomjenkinson commented 4 years ago

I think the version numbering change looks good, I note that there remains a reference with version number to several of the specifications (not JTS or interceptors) which maybe could be made consistent (added to the missing JTS/Jakarta Interceptors or removed from Jakarta Enterprise Beans/JDBC/Jakarta Messaging/Jakarta Context Dependency Injection as appropriate.

It's now a case to find the time to try to review the PDF formatting.

tomjenkinson commented 4 years ago

@hussainnm is there some way to make it so the monospace is not red? Or did other specifications move to this way of presenting the information too?

Also please can you add something like the following into the change log too?

Removed version information from several places when referencing components of other Jakarta technologies

hussainnm commented 4 years ago

The red color comes from the theme file and it is the same in all specifications https://github.com/eclipse-ee4j/jta-api/blob/master/spec/src/main/theme/jakartaee-theme.yml#L81

tomjenkinson commented 4 years ago

Thanks for the contribution @hussainnm! I am going to merge this