Documentation difficult to use

Posts   
 
    
he00273
User
Posts: 133
Joined: 02-Oct-2008
# Posted on: 20-Oct-2009 05:58:57   

I want to limit the number of entities returned when doing an Adaptor.FetchEntitycollection.

From looking at the forum I can see I can use MaxAmountOfItemsToReturn, but the code in the forum question does not match my situation.

Home > LLBLGen Pro > Bugs & Issues> MaxAmountOfItemsToReturn Problem

I did a search on your documentation for MaxAmountOfItemsToReturn and only get back


Help

No topics found.

OK

Its incredibly frustrating to know the answer is in there somewhere, but the help is not very helpful. frowning

he00273
User
Posts: 133
Joined: 02-Oct-2008
# Posted on: 20-Oct-2009 06:19:47   

he00273 wrote:

I want to limit the number of entities returned when doing an Adaptor.FetchEntitycollection.

From looking at the forum I can see I can use MaxAmountOfItemsToReturn, but the code in the forum question does not match my situation.

Home > LLBLGen Pro > Bugs & Issues> MaxAmountOfItemsToReturn Problem

I did a search on your documentation for MaxAmountOfItemsToReturn and only get back


Help

No topics found.

OK

Its incredibly frustrating to know the answer is in there somewhere, but the help is not very helpful. frowning

Ok. VS Intellisense to the rescue. I have the solution. Also I found it in the reference manual.

I still think the documentation (even at 600+ pages) can be improved with its searching.

Otis avatar
Otis
LLBLGen Pro Team
Posts: 39590
Joined: 17-Aug-2003
# Posted on: 20-Oct-2009 09:32:51   

We can't document every single property in the main documentation, that's why there's a reference manual as well. The main documentation is to explain how the framework works, perhaps here and there some details are not covered. If you want to know the details about a property, look at the reference manual.

Frans Bouma | Lead developer LLBLGen Pro
he00273
User
Posts: 133
Joined: 02-Oct-2008
# Posted on: 20-Oct-2009 10:08:38   

Otis wrote:

We can't document every single property in the main documentation, that's why there's a reference manual as well. The main documentation is to explain how the framework works, perhaps here and there some details are not covered. If you want to know the details about a property, look at the reference manual.

When I was hunting this down I thought I saw a mention of MaxAmountOfItemsToReturn in the main documentation.

When I tried to search for it again it could not find it. Perhaps I was mistaken or maybe ???

I looked at the Reference Document but it the Intellisense that solved it for me. The problem is if something is not documented (or somewhere else), then you often waste time trying to find out how to do something when you are not sure in the first place.

I was trying to get the dynamic SQL to put a top clause in my SQL. But there was no mention of this anywhere (that I could find) in the usual helpfile. confused

Perhaps you could add something to the Tutorials and Examples section for the How Do I?

Walaa avatar
Walaa
Support Team
Posts: 14946
Joined: 21-Aug-2005
# Posted on: 20-Oct-2009 11:43:41   

When I was hunting this down I thought I saw a mention of MaxAmountOfItemsToReturn in the main documentation.

When I tried to search for it again it could not find it. Perhaps I was mistaken or maybe ???

Please search the documentation for: MaxNumberOfItemsToReturn

Otis avatar
Otis
LLBLGen Pro Team
Posts: 39590
Joined: 17-Aug-2003
# Posted on: 20-Oct-2009 14:50:02   

It's a typo we discovered today, thanks to you simple_smile . It should have been MaxNumberOfItemsToReturn, not 'amount'. We'll rename this in v3.

Frans Bouma | Lead developer LLBLGen Pro
he00273
User
Posts: 133
Joined: 02-Oct-2008
# Posted on: 21-Oct-2009 02:17:56   

Otis wrote:

It's a typo we discovered today, thanks to you simple_smile . It should have been MaxNumberOfItemsToReturn, not 'amount'. We'll rename this in v3.

A pleasure to help if in only a very small way.wink I have found it now in the main documentation.simple_smile