Updates to Sheets places_in.md file #367

donaldrgosselin · 2023-09-27T23:11:01Z

beets

Please verify that the document looks good locally.

Also curious why there is a thick black and green border on the images.

beets · 2023-09-28T16:28:05Z

api/sheets/places_in.md


-**Formula**: `=DCPLACESIN(dcids, placeType)`
+## Formula {#formula}


please check the formatting of these shortcuts (or what's in the brackets). here and below.

beets · 2023-09-28T16:29:34Z

api/sheets/places_in.md


-## Assembling the information you will need to use this formula
+This section contains examples of using the `=DCPLACESIN(*dcids*, *placeType*)` formula to return lists of child places from a list of parent [Place](https://datacommons.org/browser/Place) [DCIDs](https://docs.datacommons.org/glossary.html), such as [State](https://datacommons.org/browser/State), [Country](https://datacommons.org/browser/Country), and so.


Please verify formatting of the formula. Since it's within ``, the formatting within doesn't work.

beets · 2023-09-28T16:29:49Z

api/sheets/places_in.md


-This endpoint also requires the argument `placeType`, specifying the type of the child places you desire in the response.
+![alt_text](../../assets/images/sheets/sheets_counties_delaware.png "image_tooltip")


Please give a proper tooltip

I removed the tooltip since we're not using them elsewhere.

beets · 2023-09-28T16:29:57Z

api/sheets/places_in.md


-Before trying this method out, make sure to follow the setup directions in [the main section for Sheets docs](/api/sheets/index.html).
+![alt_text](../../assets/images/sheets/sheets_districts_alaska_hawaii.png "image_tooltip")


Please give a proper tooltip

I removed the tooltip since we're not using them elsewhere.

beets

Please also ensure that the function call is included in the screenshot (like it is currently). At this point I prefer the existing screenshots on https://docs.datacommons.org/api/sheets/places_in.html

api/sheets/places_in.md

beets · 2023-09-28T16:45:22Z

api/sheets/places_in.md


-This endpoint requires the argument `dcids`. [DCIDs](/glossary.html) are unique node identifiers defined by Data Commons. Your query will need to specify the DCIDs for the parent places of interest.
+### Example 1: Retrieve a List of Counties in Delaware


Please add descriptions for these examples like the GETNAME page.

Bo said he would prefer creating videos for each example, although I do like the example descriptions in the GETNAME page. Please let me know what you decide.

We should still have text descriptions, even if there are videos or images.

I'll add them

beets

please update filenames in place (rather than adding new filenames)
comments from other PR's apply here too, such as removing the green border around images

beets · 2023-10-03T16:45:47Z

api/sheets/places_in.md

@@ -1,58 +1,38 @@
 ---
 layout: default
-title: Places within a Place
+title: Retrieving Child Nodes


This function only works with place nodes. Please update the title here and below to reflect that.

I changed it to "Retrieving Places Contained Within Another Place"

beets · 2023-10-03T16:45:56Z

api/sheets/places_in.md

 nav_order: 2
 parent: Google Sheets
 grand_parent: API
 ---

-# Retrieve places contained within another place
+# Retrieving Child Nodes


Please update

I changed it to "Retrieving Places Contained Within Another Place"

* Conformed file to get_name.md * Added Returns section * Added Error Returns section * Replaced images with narrower versions * Added steps to examples * Updated Gemfiles

beets · 2023-10-10T16:25:16Z

api/sheets/places_in.md


-## Assembling the information you will need to use this formula
+Lists of child places from a list of parent [Place](https://datacommons.org/browser/Place) [DCIDs](https://docs.datacommons.org/glossary.html), such as [State](https://datacommons.org/browser/State), [Country](https://datacommons.org/browser/Country), and so on. It only returns children with a place type that matches the <code>placeType</code> parameter.


Please rephrase this - State and Country are place types (not place dcid's). I think you want to say something like this: returns a list of child places of the specified place dcids, of the specified place type

I changed it as you suggested.

beets · 2023-10-10T16:25:49Z

api/sheets/places_in.md

+3. Retrieve the DCIDs for the congressional districts by enter `=DCPLACESIN(A1:A2, "CongressionalDistrict")` into cell C1.
+4. Finally, retrieve the names of the congressional districts by entering `=DCGETNAMES(C1:C3)` into cell D1.
+
+![alt_text](/assets/images/sheets/sheets_places_in_congressional_districts_ak_hi.png)


please use a meaningful alt_text (here and below)

beets

thanks for the updates. a few comments below

beets · 2023-10-16T18:05:54Z

assets/images/sheets/sheets_places_in_congressional_districts_ak_hi.png

please cut the "fill place dcid's" sidebar from this image - it's confusing to see Alaska in there, but the cell geoId/0200 highlighted.

beets · 2023-10-16T18:06:12Z

assets/images/sheets/sheets_places_in_counties_in_delaware.png

please cut the "fill place dcid's" sidebar from this image - it's confusing to see Delaware in there, but the cell for Kent County highlighted.

beets · 2023-10-16T18:06:45Z

api/sheets/places_in.md


-**Formula**: `=DCPLACESIN(dcids, placeType)`
+## Formula {#formula}


Suggested change

## Formula {#formula}

## Formula

beets · 2023-10-16T18:06:56Z

api/sheets/places_in.md


-*   `dcids`: A list of (parent) `Place` nodes, identified by their DCIDs.
+## Required Arguments {#required-arguments}


Suggested change

## Required Arguments {#required-arguments}

## Required Arguments

beets · 2023-11-02T23:38:43Z

Made a few updates, ptal

juliawu · 2023-11-03T18:24:40Z

api/sheets/places_in.md


-### Example 1: Retrieve a list of the counties in Delaware.
+1. Place your cursor in the cell where you want to add the DCID for Delaware. In this case, cell A2.
+2. Enter the Delaware DCID of “geoId/10”.


In line 55, we use bold instead of quotes to show what the user should enter. I personally prefer the bold, but we should probably standardize across examples (and the other pages.)

good point. it's been hard to standardize across the PR's, and i can do a sweep after the first versions are in. i'll update these to bold for now though

…to pr/367

beets · 2023-11-03T19:22:53Z

thanks for the review! updated the formatting as we discussed offline

Updates to Sheets places_in.md file

1cd9a3d

shifucun requested review from shifucun and beets September 27, 2023 23:14

beets reviewed Sep 28, 2023

View reviewed changes

Updated with Carolyn's edits

e4056fc

beets reviewed Oct 3, 2023

View reviewed changes

Updates based on Carolyn's feedback

495d0a3

* Conformed file to get_name.md * Added Returns section * Added Error Returns section * Replaced images with narrower versions * Added steps to examples * Updated Gemfiles

beets reviewed Oct 10, 2023

View reviewed changes

Updates from Carolyn

619b077

beets reviewed Oct 16, 2023

View reviewed changes

beets and others added 3 commits November 2, 2023 14:00

Text and example image updates

6f72184

Gemfile from HEAD

aeeae0c

Merge branch 'master' into drgbranch2

030880a

beets requested a review from juliawu November 2, 2023 23:37

juliawu reviewed Nov 3, 2023

View reviewed changes

juliawu approved these changes Nov 3, 2023

View reviewed changes

beets added 2 commits November 3, 2023 12:11

Merge branch 'master' of https://github.com/datacommonsorg/docsite in…

6101d73

…to pr/367

update formatting of examples

1df8e11

beets merged commit fb51dd8 into datacommonsorg:master Nov 3, 2023
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates to Sheets places_in.md file #367

Updates to Sheets places_in.md file #367

donaldrgosselin commented Sep 27, 2023 •

edited

Loading

beets left a comment

beets Sep 28, 2023

donaldrgosselin Oct 2, 2023

beets Sep 28, 2023

donaldrgosselin Oct 2, 2023

beets Sep 28, 2023

donaldrgosselin Oct 2, 2023

beets Sep 28, 2023

donaldrgosselin Oct 2, 2023

beets left a comment

beets Sep 28, 2023

donaldrgosselin Oct 2, 2023

beets Oct 3, 2023

donaldrgosselin Oct 6, 2023

beets left a comment

beets Oct 3, 2023

donaldrgosselin Oct 6, 2023

beets Oct 3, 2023

donaldrgosselin Oct 6, 2023

beets Oct 10, 2023

donaldrgosselin Oct 16, 2023

beets Oct 10, 2023

donaldrgosselin Oct 16, 2023

beets left a comment

beets Oct 16, 2023

beets Oct 16, 2023

beets Oct 16, 2023

beets Oct 16, 2023

beets commented Nov 2, 2023 •

edited

Loading

juliawu Nov 3, 2023

beets Nov 3, 2023

beets commented Nov 3, 2023


		Formula: `=DCPLACESIN(dcids, placeType)`
		## Formula {#formula}


		## Assembling the information you will need to use this formula
		This section contains examples of using the `=DCPLACESIN(dcids, placeType)` formula to return lists of child places from a list of parent [Place](https://datacommons.org/browser/Place) [DCIDs](https://docs.datacommons.org/glossary.html), such as [State](https://datacommons.org/browser/State), [Country](https://datacommons.org/browser/Country), and so.


		This endpoint also requires the argument `placeType`, specifying the type of the child places you desire in the response.
		![alt_text](../../assets/images/sheets/sheets_counties_delaware.png "image_tooltip")


		Before trying this method out, make sure to follow the setup directions in [the main section for Sheets docs](/api/sheets/index.html).
		![alt_text](../../assets/images/sheets/sheets_districts_alaska_hawaii.png "image_tooltip")


		This endpoint requires the argument `dcids`. [DCIDs](/glossary.html) are unique node identifiers defined by Data Commons. Your query will need to specify the DCIDs for the parent places of interest.
		### Example 1: Retrieve a List of Counties in Delaware


		## Assembling the information you will need to use this formula
		Lists of child places from a list of parent [Place](https://datacommons.org/browser/Place) [DCIDs](https://docs.datacommons.org/glossary.html), such as [State](https://datacommons.org/browser/State), [Country](https://datacommons.org/browser/Country), and so on. It only returns children with a place type that matches the <code>placeType</code> parameter.


		* `dcids`: A list of (parent) `Place` nodes, identified by their DCIDs.
		## Required Arguments {#required-arguments}

	## Required Arguments {#required-arguments}
	## Required Arguments

Updates to Sheets places_in.md file #367

Updates to Sheets places_in.md file #367

Conversation

donaldrgosselin commented Sep 27, 2023 • edited Loading

beets left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

beets left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

beets left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

beets left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

beets commented Nov 2, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

beets commented Nov 3, 2023

donaldrgosselin commented Sep 27, 2023 •

edited

Loading

beets commented Nov 2, 2023 •

edited

Loading