[DOCS-16354] Realm .NET SDK docs typos/inconsistency reported by customer. Created: 30/Aug/23 Updated: 13/Sep/23 Resolved: 13/Sep/23 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | Realm |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Major - P3 |
| Reporter: | Mark Brown | Assignee: | Caleb Thompson |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Participants: | |
| Days since reply: | 21 weeks, 6 days ago |
| Description |
|
From a customer at Husqvarna who is trying out Realm and Atlas Device Sync, some document typos/inconsistency:
|
| Comments |
| Comment by Caleb Thompson [ 07/Sep/23 ] | |||||||||||||||||||||
| Comment by Caleb Thompson [ 07/Sep/23 ] | |||||||||||||||||||||
|
Thanks again, mark.brown@mongodb.com! Here's the PR: https://github.com/mongodb/docs-realm/pull/3004
| |||||||||||||||||||||
| Comment by Mark Brown [ 06/Sep/23 ] | |||||||||||||||||||||
|
Some more doc feedback; the examples on this page should probably use interfaced (e.g. IRealmObject) instead of the older base classes: And the example for "See the following example for how to query a one-to-many relationship:" on the same page does not provide a one-to-many query, it just shows a filter on a collection. I am nitpicking stuff but usually these things are only visible during an initial read-through so I take the chance to mention the things I find, do with it what you like. | |||||||||||||||||||||
| Comment by Mark Brown [ 06/Sep/23 ] | |||||||||||||||||||||
|
Another:
Should be (Task -> Item etc.):In this example, note that: * The Item object's Assignee property is a User object.
| |||||||||||||||||||||
| Comment by Mark Brown [ 06/Sep/23 ] | |||||||||||||||||||||
|
More customer comments: Small document improvement here: "To define an embedded object, derive a class from EmbeddedObject. Use the syntax "<YourClass> : EmbeddedObject {}{}" to accomplish this." Should probably be (use interface instead of deprecated base class): "To define an embedded object, derive a class from IEmbeddedObject. Use the syntax "<YourClass> : IEmbeddedObject {}{}" to accomplish this." | |||||||||||||||||||||
| Comment by Mark Brown [ 30/Aug/23 ] | |||||||||||||||||||||
|
More Feedback: | |||||||||||||||||||||
| Comment by Mark Brown [ 30/Aug/23 ] | |||||||||||||||||||||
|
And some kudos as well! – I really like the documentation though! And the .NET SDK. It is evident a lot of effort has been put into this - making complex tech and concepts appear fairly simple is not easy | |||||||||||||||||||||
| Comment by Mark Brown [ 30/Aug/23 ] | |||||||||||||||||||||
|
More: The same goes for the snippet here: | |||||||||||||||||||||
| Comment by Mark Brown [ 30/Aug/23 ] | |||||||||||||||||||||
|
And further customer comments:
| |||||||||||||||||||||
| Comment by Mark Brown [ 30/Aug/23 ] | |||||||||||||||||||||
|
Further customer comments: Another possible improvement for .NET docs, I think the docs regarding (explicit) transactions here could benefit from adding a using }}statement to {{realm.BeginWrite(); in order to not risking it not being disposed (in case of some untimely exception) and to not have to explicitly call transaction.Dispose() in the {{catch }}statement (in the original code). |