search

neo4j / neo4j-go-driver

Neo4j Bolt Driver for Go
Apache License 2.0
485 stars 68 forks source link

`Driver` type does not show as Deprecated in API docs #502

Closed stefano-ottolenghi closed 1 year ago

stefano-ottolenghi commented 1 year ago

NewDriver shows as deprecated, while Driver does not.

Screenshot from 2023-06-13 04-07-37

fbiville commented 1 year ago

Thanks, let me fix that.

fbiville commented 1 year ago

Hmmm, that is strange, the deprecated comment is there: https://github.com/neo4j/neo4j-go-driver/blob/0341d94da97a3f3ce2744c26e90c90a095c75ce3/neo4j/driver.go#L30. Same as NewDriver: https://github.com/neo4j/neo4j-go-driver/blob/0341d94da97a3f3ce2744c26e90c90a095c75ce3/neo4j/driver.go#L64 🤔

fbiville commented 1 year ago

Well, well... Deprecated: is supposed to be the start of a new paragraph, which requires a blank line beforehand. And it was missing 🤦 Running the same tool as pkg.go.dev (go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsite) allowed me to confirm the issue.

fbiville commented 1 year ago

Turns out there were a few other occurrences of this problem 😓