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.

Sign up for GitHub

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

Jump to bottom

Add odoc warnings for empty packages. #14077

Merged
merged 2 commits into from
Apr 6, 2021
Merged

Add odoc warnings for empty packages. #14077

merged 2 commits into from
Apr 6, 2021

Conversation

Zimmi48
Copy link
Member

@Zimmi48 Zimmi48 commented Apr 6, 2021

Kind: documentation

Fixes / closes #14055

@Zimmi48 Zimmi48 added kind: documentation Additions or improvement to documentation. kind: internal API, ML documentation... labels Apr 6, 2021
@Zimmi48 Zimmi48 added this to the 8.14+rc1 milestone Apr 6, 2021
@Zimmi48 Zimmi48 requested a review from a team as a code owner April 6, 2021 09:43
@ejgallego ejgallego self-assigned this Apr 6, 2021
@ejgallego
Copy link
Member

Umm, @Zimmi48 we are missing the actual mld files, aren't we?

@Zimmi48
Add odoc warnings for empty packages.
acae2dc 
From an OCaml library point of view.
@Zimmi48 Zimmi48 force-pushed the warnings-for-empty-packages branch from 2379920 to acae2dc Compare April 6, 2021 13:01
@Zimmi48 Zimmi48 requested review from a team as code owners April 6, 2021 13:01
@Zimmi48
Copy link
Member Author

Zimmi48 commented Apr 6, 2021

Sorry, I forgot to git add .

@Zimmi48
Copy link
Member Author

Zimmi48 commented Apr 6, 2021

Here is the result: https://coq.gitlab.io/-/coq/-/jobs/1156498947/artifacts/_build/default/_doc/_html/index.html

@ejgallego
Copy link
Member

Nice, we could add a link to ../coq-core from the mld in Coq if desired, otherwise we can merge like this.

@Zimmi48
Copy link
Member Author

Zimmi48 commented Apr 6, 2021

I didn't know how links work in ocamldoc, that's why I didn't put any.

@ejgallego
Copy link
Member

Quoting the docs:

{{: string }  text } | put a link to the given address (given as string) on the given text.

https://ocaml.org/manual/ocamldoc.html#s%3Aocamldoc-comments

@Zimmi48
Copy link
Member Author

Zimmi48 commented Apr 6, 2021

Thanks. Done.

ejgallego
ejgallego approved these changes Apr 6, 2021
View reviewed changes
Copy link
Member

@ejgallego ejgallego left a comment

Choose a reason for hiding this comment

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

Works fine, thanks!

We should improve the index pages quite a bit, but this is a start.

@ejgallego
Copy link
Member

@coqbot: merge now

@coqbot-app coqbot-app bot merged commit daba2de into coq:master Apr 6, 2021
@Zimmi48 Zimmi48 deleted the warnings-for-empty-packages branch April 7, 2021 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ejgallego ejgallego ejgallego approved these changes

Assignees

@ejgallego ejgallego

Labels
kind: documentation Additions or improvement to documentation. kind: internal API, ML documentation...
Projects
None yet
Milestone
8.14+rc1
Development

Successfully merging this pull request may close these issues.

Docs for Coq's API doesn't show up
2 participants
@Zimmi48 @ejgallego