judgelord / regulationsdotgov

a package to get data from regulations.gov
https://judgelord.github.io/regulationsdotgov/
MIT License
0 stars 0 forks source link

commentOnId uses objectId #20

Open mzkhuzam opened 3 weeks ago

mzkhuzam commented 3 weeks ago

I realized that commentOnId uses objectId which must be obtained from the metadata, users have to first use get_documents in order to obtain the objectId for a document. Alternatively, documentIds are public-facing on regulations.gov and included in the metadata.

Not sure if one obtains more information than the other but flagging this as something to deal with in documentation and maybe deal with later. I don't want to create two functions that do the same thing ...

judgelord commented 3 weeks ago

yes, our current draft documentation specifies two functions:

Get metadata for comments on a document or docket

However, they could probably just be one get_comments function that takes a docket = or document_id argument...or maybe even detects whether a docket id, document id, or object id is supplied.