Skip to content

ENH-296 Giving Tuesday, Metrics and Documentation - #297

Open
grant-minor-sntialtech wants to merge 9 commits into
mainfrom
ENH-296-GivingTuesday-Metrics-Docs
Open

ENH-296 Giving Tuesday, Metrics and Documentation#297
grant-minor-sntialtech wants to merge 9 commits into
mainfrom
ENH-296-GivingTuesday-Metrics-Docs

Conversation

@grant-minor-sntialtech

Copy link
Copy Markdown

No description provided.

@grant-minor-sntialtech

Copy link
Copy Markdown
Author

I believe to correct the prettier stuff I just run:
npm run lint:prettier

Correct?

Comment thread src/getMetrics.ts Outdated
@bickelj

bickelj commented Aug 20, 2026

Copy link
Copy Markdown
Collaborator

@grant-minor-sntialtech I don't want to get too pedantic about commit histories but I think we'll want to squash/rebase all the fixes into 1-3 commits before pushing. I asked GLM-5.2 for a review and it usually gives decent feedback.

@bickelj

bickelj commented Aug 20, 2026

Copy link
Copy Markdown
Collaborator

@grant-minor-sntialtech I think the enormous docs files might be too verbose to maintain. It looks like they were generated as summaries of what can be found in the code, and if they are useful I suppose they should stay. But perhaps they can be condensed to repeat less of what can be easily found when examining the code. I like the little tables showing which commands need PDC auth and which don't, though, that part is very handy.

@bickelj-agent

Copy link
Copy Markdown
Collaborator

Reviewed PR #297; npm run lint and the full Jest suite (68 tests) pass locally. Three follow-ups, posted inline: the pdc-bulk-uploaderpdc-metrics default change left the code comment and the docs inconsistent, and src/getMetrics-report.md is referenced but does not exist.

Minor, not commented inline
  • All three new docs use repo-relative links that resolve wrong from docs/ (e.g. [src/index.ts](src/index.ts)docs/src/index.ts); consider ../src/.... docs/getMetrics.md line 3 also drops the src/ prefix ([getMetrics.ts](getMetrics.ts)) while the other two docs keep it.
  • classifyHttpError reports Unexpected HTTP status undefined for transport errors with no response; a distinct note for the no-response case would read more clearly.

— GLM-5.2

Comment thread src/getMetrics.ts Outdated
Comment thread docs/getMetrics.md Outdated
@grant-minor-sntialtech

Copy link
Copy Markdown
Author

For the comment around:
classifyHttpError reports Unexpected HTTP status undefined for transport errors with no response; a distinct note for the no-response case would read more clearly.

I'm not an expert, but I don't believe there is a status for 'no response'. You still get a header and stuff... Is this to start tracking network timeouts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants