Skip to content
This repository has been archived by the owner on Jun 24, 2021. It is now read-only.

JDK-8207328: Javadocs of Stylesheet are outdated #122

Closed
wowselim opened this issue Jul 5, 2018 · 14 comments
Closed

JDK-8207328: Javadocs of Stylesheet are outdated #122

wowselim opened this issue Jul 5, 2018 · 14 comments
Labels
bug Something isn't working documentation Updates or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@wowselim
Copy link
Contributor

wowselim commented Jul 5, 2018

javafx.css.Stylesheet javadocs are a bit confusing. For example the convertToBinary method receives two java.io.File parameters, while talking about URLs. Similarly the loadBinary method receives a URL but talks about the parameter as InputStream.
On a side note, the getUrl method returns a String which is also a bit confusing.

https://docs.oracle.com/javase/9/docs/api/javafx/css/Stylesheet.html

@nlisker
Copy link

nlisker commented Jul 5, 2018

Added to JDK-8204653.

@eugener eugener added bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed labels Jul 6, 2018
@wowselim
Copy link
Contributor Author

wowselim commented Jul 7, 2018

Hi @nlisker ,

I have sent my signed contributor agreement to oracle and I'm waiting for a reply. Can I fix the mentioned javadocs myself and submit a pull request? I can see that the issue you linked is assigned to you so I wanted to ask before I do anything.

Selim

@nlisker
Copy link

nlisker commented Jul 7, 2018

Yes, I'll unlink it. You'll have to submit a JBS bug though.

@kevinrushforth
Copy link
Collaborator

@wowselim we will need to wait for your OCA to be recorded before we can act on your PR.

@nlisker
Copy link

nlisker commented Jul 15, 2018

@wowselim Note that late July is the deadline (unless stated otherwise) to push this change into 11, so if you don't get it done by that point, I'll want to do it myself. Did you submit a JBS issue?

@wowselim
Copy link
Contributor Author

hi @nlisker I don't have an account on the bug tracker. I also didn't receive a reply from oracle regarding my agreement yet. The changes are on my fork already but I can't really do anything...

@nlisker
Copy link

nlisker commented Jul 15, 2018

@wowselim You don't need an account, submit the bug through https://bugreport.java.com/bugreport/. @kevinrushforth can move it. Maybe he can check on your OCA while at it.

@wowselim
Copy link
Contributor Author

I wasn't aware of that, I created an issue now (internal ID : 9056056)

@kevinrushforth
Copy link
Collaborator

It has been transferred to the JDK project as JDK-8207328

@kevinrushforth kevinrushforth changed the title Javadocs of Stylesheet are outdated JDK-8207328: Javadocs of Stylesheet are outdated Jul 16, 2018
@kevinrushforth
Copy link
Collaborator

Regarding the OCA, I can check on it.

@wowselim
Copy link
Contributor Author

@kevinrushforth sorry to bug you but are there any news regarding my OCA? Otherwise I suggest @nlisker just takes this issue since the deadline seems to be too close now.

@kevinrushforth
Copy link
Collaborator

@wowselim I sent an inquiry today and will update you as soon as I hear back

@kevinrushforth
Copy link
Collaborator

@wowselim Your OCA has been recorded. You can submit a PR to fix this when read. Note that doc-only bugs can still be fixed for openjfx11 during RDP2.

@wowselim
Copy link
Contributor Author

wowselim commented Aug 4, 2018

I forgot to link to this issue from my commit message but I created following pull request: #147

@eugener eugener added the documentation Updates or additions to documentation label Aug 21, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working documentation Updates or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants