Skip to content
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

[DOCS] Arrange items in the API reference in alphabetical order #659

Merged
merged 1 commit into from
Aug 16, 2022

Conversation

sekikn
Copy link
Contributor

@sekikn sekikn commented Aug 8, 2022

Did you read the Contributor Guide?

Is this PR related to a JIRA ticket?

  • No, this is a documentation update. The PR name follows the format [DOCS] my subject.

What changes were proposed in this PR?

Currenly, the items in the API reference seems to be ordered randomly,
and it makes difficult for users to find the function they need.
It is more user-friendly if they were arranged in alphabetical order.

How was this patch tested?

Ran mkdocs serve locally and made sure that the API docs were fixed as expected.

Did this PR include necessary documentation updates?

  • Yes, I have updated the documentation update.

Currenly, the items in the API reference seems to be ordered randomly,
and it makes difficult for users to find the function they need.
It is more user-friendly if they were arranged in alphabetical order.
@jiayuasu jiayuasu added the docs label Aug 9, 2022
@jiayuasu jiayuasu added this to the sedona-1.3.0 milestone Aug 9, 2022
@jiayuasu jiayuasu merged commit 36af55a into apache:master Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants