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

Better docs for sets and intsets #10362

Merged
merged 2 commits into from
Jan 22, 2019
Merged

Conversation

narimiran
Copy link
Member

(do not squash when merging)

@alehander92
Copy link
Contributor

this should be a part of the style guide, but can we have an empty line between examples and code? it seems harder to separate them that way IMO , even with the indent

@narimiran
Copy link
Member Author

can we have an empty line between examples and code? it seems harder to separate them that way IMO , even with the indent

For my personal projects, I use 4-space indentation for runnableExamples, which IMO makes separation much clearer. But I know that @Araq once said he doesn't want that style in stdlib. (Maybe he changed his mind in the mean time?)

When it comes to an empty line between, I'm not sure. When function body is just oneliner, and the space between functions is also one line, it makes stuff even worse, readability-wise.

@alehander92
Copy link
Contributor

I don't agree: usually examples are longer than short functions, and I feel having them separated helps noticing where the actual function begins: but this is subjective!

@Araq Araq merged commit 39e1cd2 into nim-lang:devel Jan 22, 2019
@Araq
Copy link
Member

Araq commented Jan 22, 2019

Sorry about the squash.

ThomasTJdev pushed a commit to ThomasTJdev/Nim that referenced this pull request Jan 27, 2019
* better docs: sets

* better docs: intsets
@narimiran narimiran deleted the sets-docs-squashed branch January 30, 2019 06:10
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