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 for TrieMap module #128

Merged
merged 6 commits into from
Jul 16, 2020
Merged

Docs for TrieMap module #128

merged 6 commits into from
Jul 16, 2020

Conversation

matthewhammer
Copy link
Contributor

@matthewhammer matthewhammer commented Jul 14, 2020

I followed @kritzcreek's example in HashMap.

One question for the hyperlinks: What happens when we produce non-html output?

The current links seem brittle and likely to break, right? (or link to the wrong kind of document when we generate non-html output?)

@kritzcreek
Copy link
Contributor

One question for the hyperlinks: What happens when we produce non-html output?

They just appear unescaped as the text in the comment. Not pretty but can at least be deciphered.

The current links seem brittle and likely to break, right?

They are. We'll need to come up with a referencing schema. My plan is to start with the intra-rustdoc RFC and see how far that would get us. I fear it'll involve me writing/extending an OCaml Markdown parser which I'm not excited about.

Copy link
Contributor

@kritzcreek kritzcreek left a comment

Choose a reason for hiding this comment

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

Just a few links

src/TrieMap.mo Outdated Show resolved Hide resolved
src/TrieMap.mo Outdated Show resolved Hide resolved
crusso and others added 2 commits July 15, 2020 23:42
Co-authored-by: Christoph Hegemann <6189397+kritzcreek@users.noreply.github.com>
src/TrieMap.mo Outdated Show resolved Hide resolved
Copy link
Contributor

@crusso crusso left a comment

Choose a reason for hiding this comment

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

LGTM, applied @kritzcreek comments, so will merge

@crusso
Copy link
Contributor

crusso commented Jul 15, 2020

Looks like @kritzcreek needs to approve again

@matthewhammer
Copy link
Contributor Author

Looks like @kritzcreek needs to approve again

What's the reviewer semantics here? I'm afraid that (as usual), I may be misunderstanding some aspect of GitHub : )

For instance, is it preferable to have more reviewers for a quick review, or fewer (e.g., do they all need to re-approve every commit)?

@matthewhammer matthewhammer merged commit b15c0a0 into master Jul 16, 2020
@matthewhammer matthewhammer deleted the doc-triemap branch July 16, 2020 21:28
kritzcreek pushed a commit that referenced this pull request Jul 17, 2020
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