Skip to content

NH-2444: Adding some documentation for Linq querying API. #567

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

Merged
merged 1 commit into from
Mar 15, 2017

Conversation

fredericDelaporte
Copy link
Member

NH-2444 ask for documenting the Linq provider. Here is a minimal documentation for it.
There is no "unsupported feature" section as asked in a comment: this may change too frequently in my opinion. (And I do not have an exhaustive knowledge of it.)
There is no "extensions" section too: I feel it a bit hard to properly document.

Any feedback welcome!

@fredericDelaporte
Copy link
Member Author

I think I should add a "supported data types methods and properties" section for documenting things like support of DateTime.Year, string.Length, and whatever else I find in the DefaultLinqToHqlGeneratorsRegistry.
I may move there a part of the "miscellaneous" section, which may then disappear (I do not like such section).
And by the way I could give some starting point for adding custom generators, but without much more explanations than "go see the sources for examples", especially about expression conversion to HQL trees.

@fredericDelaporte
Copy link
Member Author

"Supported methods and members" section committed. "Miscellaneous" is shorter but still there, and I have not added explanations for adding custom generator for now.

@fredericDelaporte
Copy link
Member Author

Minimal explanations for a custom generator added. Heavily example based, and far from covering all cases, it recommends checking NHibernate sources for more. (Should I include a direct link on Github?)
There is no "misc" section anymore.

I do not think I will made more changes, unless I have to take into account some feedback.

@hazzik hazzik merged commit 7088fe9 into nhibernate:master Mar 15, 2017
@fredericDelaporte fredericDelaporte deleted the NH-2444 branch March 15, 2017 17:41
@hazzik hazzik modified the milestone: 5.0.0 Mar 24, 2017
@hazzik hazzik added the r: Fixed label Aug 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants