Improve derived_scalars readme

openai / transformer-debugger

MIT License

4.01k stars 231 forks source link

Improve derived_scalars readme #11

Closed machina-source closed 5 months ago

machina-source commented 5 months ago

Improve markdown spacing/style (was dense, now easier to read)
Add links for file references where relevant
Clarify indirect references, all wording kept as-is otherwise
Update code comment casing for codebase consistency

Also added section headers, horizontal rules, and numbered steps for derived scalar computation.

Open to all feedback, thank you.

BEFORE: DS-README-BEFORE

AFTER: DS-README-AFTER

stevenbills commented 5 months ago

I'm still figuring out the permissions for this repo. I'm curious: do you have the ability to merge this PR now that it's approved? (If so feel free to do so!) Not sure if I need to merge PRs myself.

machina-source commented 5 months ago

It does not allow me to merge the PR on my side even though the changes are approved. The UI says write access to the repo is required to merge PRs.

This is what I see:

REQ-WRITE-ACCESS

stevenbills commented 5 months ago

Thanks for letting me know! Merging now.