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

crud: fix ldoc comments #323

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

DifferentialOrange
Copy link
Member

@DifferentialOrange DifferentialOrange commented Sep 20, 2022

How-to generate:

$ tarantoolctl rocks install ldoc --server=https://tarantool.github.io/LDoc/
$ ./.rocks/bin/ldoc -c $(pwd)/doc/ldoc/config.ld -d $(pwd)/doc/apidoc/ crud
$ xdg-open doc/apidoc/index.html

What has been done? Why? What problem is being solved?

I didn't forget about

  • Tests
  • Changelog
  • Documentation

Closes #???

How-to generate:

$ tarantoolctl rocks install ldoc --server=https://tarantool.github.io/LDoc/
$ ./.rocks/bin/ldoc -c $(pwd)/doc/ldoc/config.ld -d $(pwd)/doc/apidoc/ crud
$ xdg-open doc/apidoc/index.html
@DifferentialOrange DifferentialOrange mentioned this pull request Sep 20, 2022
3 tasks
@Totktonada
Copy link
Member

How-to generate:

Maybe add a script into the repository?

@DifferentialOrange
Copy link
Member Author

How-to generate:

Maybe add a script into the repository?

This is just a draft of what @ligurio had once done. I have just reopened PR under my name after Sergey's request. If someone would finish it, I'm sure there will be some script. But now it's not a part of our short term plans: I'm just preserving what was done because it may be helpful later.

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.

None yet

3 participants