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

delete @select! reference #219

Merged
merged 2 commits into from
Jan 8, 2021
Merged

Conversation

pdeffebach
Copy link
Collaborator

@pdeffebach pdeffebach commented Jan 7, 2021

In reference to #218. We shouldn't update the readme to discuss @select! and @transform! until we make a new release.

I would rather wait for a new release until we have @subset and @subset! and maybe and @orderby!.

cc @nalimilan

Copy link
Member

@bkamins bkamins left a comment

Choose a reason for hiding this comment

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

Though I would remove the documentation from README.md entirely

@pdeffebach
Copy link
Collaborator Author

I think the best solution is to take the current version of the readme and make it the docstring for the module. Then we can add to that as needed. Then before releases we just copy over the docstring as is to the actual readme.

@nalimilan
Copy link
Member

There's already a list of provided function in the homepage of the Documenter manual. So why not remove the list from the README completely? I don't think it's standard to have a docstring for a module listing all functions it exports: Documenter does that automatically already so adding a manual list which is likely to get outdated isn't great.

@pdeffebach
Copy link
Collaborator Author

Okay, updated to delete the list of macros entirely. With an approval I will merge.

@pdeffebach pdeffebach merged commit 6f583e7 into JuliaData:master Jan 8, 2021
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.

3 participants