Update doc strings #290
Update doc strings #290
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## develop #290 +/- ##
===========================================
- Coverage 87.65% 87.59% -0.07%
===========================================
Files 58 58
Lines 3322 3322
===========================================
- Hits 2912 2910 -2
- Misses 410 412 +2
|
| "on the same compute hosts an a Model instance defined by the user. In this\n", | ||
| "deployment, the database is not connected together in a cluster and each shard\n", | ||
| "of the database is addressed individually by the processes running on that compute\n", | ||
| "host. This is particularly important for GPU-intensive workloads which require\n", | ||
| "frequent communication with the database.\n", | ||
| "\n", | ||
| "<img src=\"https://www.craylabs.org/docs/_images/co-located-orc-diagram.png\" alt=\"lattice\" width=\"600\"/>\n" | ||
| "<img src=\"https://www.craylabs.org/docs/_images/colocated-orc-diagram.png\" alt=\"lattice\" width=\"600\"/>\n" |
There was a problem hiding this comment.
Just confirming that this link does correspond with the colocated-orc-diagram.png whose name was changed in this pr. Do we care that this may not render if a user were to pull this notebook from develop as opposed to from a release?
We have the docker container for tutorials that we expect users to use so I imagine very few are pulling and running the dev branch on bare metal, so I'm tempted to say its fine.
There was a problem hiding this comment.
Yeah, after you raised it I'm reconsidering my original choice. develop should be fully functioning and the release is probably 4 weeks away. Let me change this back and then I'll have a separate ticket to update the file name right before launch.
There was a problem hiding this comment.
Actually, I think I'm in favor of just not updating it at all. It's an internal filename and if we change it previous versioned releases will be broken because once we publish this to the main docs the file won't exist anymore. Do you agree with that? It's an edge case but I guess not much is gained by fixing an internal file name.
There was a problem hiding this comment.
I think that seems like a perfectly reasonable justification to just leave the current filename! Like you said, its strictly internal, so I'm totally fine with letting this be one place where the "co-loctated" spelling still exists
Per group discussion, updating doc strings to the correct form of colocated.