question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Address Feedback from JS/Java User Studies

See original GitHub issue

Java and Js UX study feedback

  • Add readme code snippet pointers for statements in key concepts. uses it extensively and users have not seen/known how to use it before this in other SDK’s?
  • Should consider having a helper method to shortcut getFields().get("FieldName") - rather than helper method, we will leave it as is and update unlabeled samples to show efficient way of getting fields by name.
  • For Copy, hard to find resource id and region. Add docstrings to clarify this more. Add in the documentation how/where to get the region for Copy and the list of available regions
  • Consider adding a mix of fromUrl and stream overload code snippets in the main readme.
  • Add documentation about how to create the training blob and the type of files and etc. Add link to service documentation for creating training data storage containers.
  • getText and getTextContent – clarify ref docs
  • Make sure sync and async links are clearly represented in samples list - All language to cross-check
  • Add to documentation description about what SAS Url is – Add links to service docs about training

To follow up:

  • Should consider having a getRow() or similar not natural to have a getCells() and diving into the cell information to find the row it belongs to. Also, it could use a better data structure here. [constant pain point to get to the field] - _Follow up (Mariana/Anne) Table indexer issue - https://github.com/Azure/azure-sdk-for-net/issues/9975_ NOT IN PREVIEW 4
  • 2/5 users attempted and were hopeful that they could pass in the local File URL for the fromUrl and that should have worked. Circling back to if we should consider adding an overload that takes in a file input. - (Waiting to know Johan’s thoughts, Issue - https://github.com/Azure/azure-sdk-for-java/issues/12402#issue-643410189)
  • Add documentation to clarify getFieldValue() and getValueText() - Deferred discussion to Architecture board. Consider if renaming fields to labelData or labelTextInformation should help ?

Only Java

  • [Java] Add a FormTraining client building example in the README
  • [Only Java] Rename fieldValue to Value
  • [Java] Nullable params to be called out in documentation
  • [Java] Models like BoundingBox and Points to have toString() override?
  • [Java] Consider updating samples to better show the polling mechanism as this library
  • [Java] Rename getFieldMap() to getFields() in CustomFormSubmodel [including documentation]
  • [Java] requires length for inputstream overloads , not required for other languages. - Client side optimization in Java

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:6 (6 by maintainers)

github_iconTop GitHub Comments

1reaction
annelo-msftcommented, Jun 17, 2020

for

Should consider having a getRow() or similar not natural to have a getCells() and diving into the cell information to find the row it belongs to. Also, could use a better data structure here. [constant pain point to get to the field]

We have this work item in .NET. Not sure what would be idiomatic to other languages.

0reactions
johanstecommented, Jun 22, 2020

fromUrl will presumably not open the file on the client but rather send the url/location of the image to the service, and the service will open and read from that location. What we need to make sure is that it is abundantly clear when the service will do the “open” of the file/URL and when the client will do the “open” of the file/URL. This is why we have two methods.

Read more comments on GitHub >

github_iconTop Results From Across the Web

[Design] Address Feedback from JS/Java User Studies #12477
In unsupervised recognize sample, show how to search for a certain field name in the dict => #12960 Add to documentation description about ......
Read more >
Responsible Conduct in Collaborative Research
The development team appreciates receiving constructive and specific feedback on any mistakes or problems identified by users. Some problems encountered by ...
Read more >
How to Write Doc Comments for the Javadoc Tool - Oracle
This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, Oracle....
Read more >
Exploiting JNDI Injections in Java | Veracode blog
When the name of the requested object is controlled by an attacker, it is possible to point a victim Java application to a...
Read more >
Integrate in-app reviews (Kotlin or Java) - Android Developers
This guide describes how to integrate in-app reviews in your app using either Kotlin or Java. There are separate integration guides if you...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found