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

Improve documention about Quantity attributes #67

Closed
AndreasZaschka opened this issue Dec 11, 2014 · 5 comments
Closed

Improve documention about Quantity attributes #67

AndreasZaschka opened this issue Dec 11, 2014 · 5 comments
Assignees
Labels
in: documentation Reference documentation, Javadoc, website lifecycle: feedback requested Information missing
Milestone

Comments

@AndreasZaschka
Copy link

Out of the last 'Lernraum'-Session, the question of customizing the quantity in the view.

  • object.quantity offers the toString() with amount and metric (e.g. 20units).

Here the students like some more detailed information:

  • object.quantity.amount offers only the amount,
  • object.quantity.metric offers only the metric,
  • ...
@odrotbohm
Copy link
Member

What does "more detailed information" mean exactly? Related to the JavaDoc?

@odrotbohm odrotbohm added the lifecycle: feedback requested Information missing label Dec 12, 2014
@AndreasZaschka
Copy link
Author

That's a good question, the problem is the usage in HTML (Thymeleaf).
The students like to known, who to access only the amount of the quantity.
So i'm not sure, where to place the info of accessing attributes via Thymeleaf.

Maybe an UML-Diagram of Quantity with the attributes in the technical reference is enough.

@AndreasZaschka AndreasZaschka self-assigned this Dec 18, 2014
@odrotbohm
Copy link
Member

The fix for #9 has introduced a new, simplified Quantity API. I am not quite sure how the diagram is supposed to help explaining the usage from within Thymeleaf templates. Maybe extracting some code snippets from the Videoshop sample and adding them to the reference documentation would help?

@AndreasZaschka
Copy link
Author

Yes, i agree for that. Documentation need to be edit at this point.

@AndreasZaschka AndreasZaschka added the in: documentation Reference documentation, Javadoc, website label Aug 26, 2015
AndreasZaschka pushed a commit that referenced this issue Oct 19, 2015
odrotbohm pushed a commit that referenced this issue Oct 19, 2015
@odrotbohm
Copy link
Member

I polished the commit to use a better summary to make sure browsing the commit history actually revelas the intent of the change.

@odrotbohm odrotbohm added this to the 6.2 GA milestone Oct 19, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: documentation Reference documentation, Javadoc, website lifecycle: feedback requested Information missing
Projects
None yet
Development

No branches or pull requests

2 participants