further documentation refinements

Signed-off-by: Neal Ensor <[email protected]>

Author: nensor

CHANGELOG.md

@@ -123,7 +123,7 @@
 - **bug** Fix issue with access limitation validation on new records
 - **bug** Fix typing of pams_publication_status field
 
-## 0.4.9 - 6/17/2025
+## 0.4.9 - 6/24/2025
 - Add legacy access limitation values for validation
 - Modify PAMS publication status constants to reflect proper values (int to str)
 - Add "process_exceptions" to MediaFile data

README.md

@@ -78,13 +78,16 @@ functionality, and does not constitute release of STI information to the product
 It is not required to maintain separate python library dependencies for these different environments; the library instance may connect to either service
 depending on how you instantiate it.
 
+Note that documentation via python help functionality is provided for most of the library functions, via `help(Elink)` or `help(Elink.post_new_record)` for
+example.
+
 ```python
 from elinkapi import Elink
 
 api = Elink(target="TARGET_URL", token="__Your_API_Token__")
 ```
 
-Again, if you do not specify the `TARGET_URL` above, the production E-Link will be utilized.  Specify `https://review.osti.gov/elink2api/` as the `TARGET_URL` above to access the Review E-Link environment.  Adjust the `token` value to the appropriate API user token for the correct target environment prior to utilizing the functions.
+Again, if you do not specify the `TARGET_URL` above, the production E-Link will be utilized.  Specify `https://review.osti.gov/elink2api/` as the `TARGET_URL` above to access the Review E-Link environment.  Adjust the `token` value to the appropriate API user token for the correct target environment prior to utilizing the functions.  The production environment endpoint value is `https://www.osti.gov/elink2api/`.
 
 If you wish to interactively change either value, there are convenience methods available:
 
@@ -525,6 +528,8 @@ Matches the [Identifiers model](https://www.osti.gov/elink2api/#tag/identifier_m
 Matches the [Related Identifiers model](https://www.osti.gov/elink2api/#tag/related_identifier_model) described in E-Link 2.0's API documentation
 
 ### Geolocation<a id="geolocation"></a>
+Information for any geolocation information (as pairs of latitude and longitude points) associated with a record's information.
+
 <u>Schema</u>
 ```python
 Geolocation: {
@@ -556,6 +561,13 @@ Point: {
 ```
 
 ### Media Info<a id="media-info"></a>
+Information for a "media set" associated with a record; that is, one or more media files, such as PDF or Word documents, or off-site URLs (for dataset
+records), along with any derived or processed files produced by media processing.  Such derived files are usually cached URL content, text extracted
+from full text files, or OCR-processed PDF files as applicable.
+
+Each media set is uniquely identified by the generated "media_id" value, and each "osti_id" record may be associated with one or more such media sets.
+The set contains individual "files" (see "Media File" below) making up its content.
+
 <u>Schema</u>
 ```python
 [
@@ -605,6 +617,12 @@ Point: {
 
 
 ### Media File<a id="media-file"></a>
+An individual media file within a "media set"; usually a PDF or Word document uploaded by the user, or a processed file derived from that upload.  The 
+"media_type" of "O" (for original) indicates the single user-provided document, which is usually the fulltext reference on OSTI.gov for this record.
+Derived files, such as text extracted (media_type="T"), cached URL content (media_type="C") will also be present in the media set.
+
+Each media file is uniquely identified by its "media_file_id" sequence number, generated by OSTI when the files are uploaded or processed.
+
 <u>Schema</u>
 ```python
 {