Skip to content

Enhance spatial documentation with clearer descriptions and examples #433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 30, 2025

Conversation

Andy2003
Copy link
Collaborator

No description provided.

@Andy2003 Andy2003 added the doc Documentation label Mar 30, 2025
@Andy2003 Andy2003 requested a review from Copilot March 30, 2025 10:43
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the documentation configuration to support API documentation adjustments. Key changes include:

  • Adding a new "urls" block with an "html_extension_style" configuration.
  • Adding an "extensions" list under the "asciidoc" section to include the macro.
  • Updating the "page-theme" attribute from "docs" to "labs" to reflect the new styling.
Files not reviewed (19)
  • docs/docs/modules/ROOT/nav.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/index.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial.addNode/spatial.addNode.byId.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial.addNodes/spatial.addNodes.byId.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial.removeNode/spatial.removeNode.byId.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial.removeNodes/spatial.removeNodes.byId.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial/spatial.addLayer.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial/spatial.addLayerWithEncoder.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayer.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerGeohash.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerHilbert.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerWithConfig.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerXY.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial/spatial.addNativePointLayerZOrder.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial/spatial.addNode.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial/spatial.addNodes.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayer.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayerGeohash.adoc: Language not supported
  • docs/docs/modules/ROOT/pages/api/spatial/spatial.addPointLayerHilbert.adoc: Language not supported
Comments suppressed due to low confidence (2)

docs/docs.yml:14

  • [nitpick] Consider using a consistent naming convention (for example, hyphen-case) for configuration keys if that aligns better with the rest of the file.
html_extension_style: indexify

docs/docs.yml:20

  • Ensure that the change from 'docs' to 'labs' for the page theme is intentional as it might affect the overall styling.
page-theme: labs

Copy link

Test Results

343 tests  +11   318 ✅ +11   10m 20s ⏱️ +18s
 35 suites + 1    25 💤 ± 0 
 35 files   + 1     0 ❌ ± 0 

Results for commit c4ba077. ± Comparison against base commit 0ad6edd.

This pull request removes 1 and adds 12 tests. Note that renamed tests count towards both.
org.neo4j.gis.spatial.procedures.SpatialProceduresTest ‑ add_a_node_to_multiple_different_indexes_for_both_simple_and_native_points
org.neo4j.gis.spatial.DocGeneratorTest ‑ generateDocStub
org.neo4j.gis.spatial.functions.SpatialFunctionsTest ‑ create_point_geometry_ad_map
org.neo4j.gis.spatial.procedures.SpatialProceduresTest ‑ testAddNativePointLayerWithConfig
org.neo4j.gis.spatial.procedures.SpatialProceduresTest ‑ testAddNativePointLayerXY
org.neo4j.gis.spatial.procedures.SpatialProceduresTest ‑ testPointLayer(String, String)[1]
org.neo4j.gis.spatial.procedures.SpatialProceduresTest ‑ testPointLayer(String, String)[2]
org.neo4j.gis.spatial.procedures.SpatialProceduresTest ‑ testPointLayer(String, String)[3]
org.neo4j.gis.spatial.procedures.SpatialProceduresTest ‑ testPointLayer(String, String)[4]
org.neo4j.gis.spatial.procedures.SpatialProceduresTest ‑ testPointLayer(String, String)[5]
org.neo4j.gis.spatial.procedures.SpatialProceduresTest ‑ testPointLayer(String, String)[6]
…

@Andy2003 Andy2003 changed the title Add API Doc Enhance spatial documentation with clearer descriptions and examples Mar 30, 2025
@Andy2003 Andy2003 merged commit 522ad0e into master Mar 30, 2025
2 checks passed
@Andy2003 Andy2003 deleted the feature/add-api-doc branch March 30, 2025 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant